{"enable_dnssec_for_domains":{"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Security","description":"DNS / DNS Security"}],"paths":{"/enable_dnssec_for_domains":{"get":{"tags":["DNS","DNS Security"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enable_dnssec_for_domains \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_dnssec_for_domains?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable DNSSEC on domain","operationId":"enable_dnssec_for_domains","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.","parameters":[{"schema":{"type":"string","format":"domain","example":"example.com"},"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-alternative":{"value":"domain=example.com&domain=example1.com&domain=example2.com","summary":"Multiple domains"},"multiple":{"value":"domain=example.com&domain-1=example1.com&domain-2=example2.com","summary":"Multiple domains"},"single":{"summary":"A single domain.","value":"example.com"}},"required":"true","name":"domain","in":"query"},{"in":"query","name":"active","required":"false","description":"Whether to activate the newly-created key.\n* `1` - Activate the key.\n* `0` - Do **not** activate the key.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"1"}},{"schema":{"type":"integer","default":"8","example":"8","enum":["5","6","7","8","10","13","14"]},"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.","required":"false","in":"query","name":"algo_num"},{"schema":{"type":"string","default":"classic","enum":["classic","simple"],"example":"classic"},"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.","required":"false","in":"query","name":"key_setup"},{"name":"use_nsec3","in":"query","required":"false","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.","schema":{"default":"1","enum":["0","1"],"example":"1","type":"integer"}},{"schema":{"default":"7","example":"7","minimum":"1","type":"integer","maximum":"500"},"description":"The number of times that the system rehashes the first resource record hash operation.","required":"false","name":"nsec3_iterations","in":"query"},{"in":"query","name":"nsec3_narrow","required":"false","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.","schema":{"default":"1","example":"1","enum":["0","1"],"type":"integer"}},{"schema":{"default":"0","example":"1","enum":["0","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.","required":"false","name":"nsec3_opt_out","in":"query"},{"schema":{"type":"string","example":"1a2b3c4d5e6f"},"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).","required":"false","in":"query","name":"nsec3_salt"}],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"example":"enable_dnssec_for_domains","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"domains":{"type":"array","items":{"properties":{"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.","example":"1","enum":["0","1"],"type":"integer"},"nsec_version":{"enum":["NSEC3","NSEC"],"example":"NSEC3","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.","type":"string"},"nsec_error":{"example":"Error message.","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.","type":"string"},"new_key_id":{"example":"2","description":"The assigned security key ID. A valid ID.","type":"string"},"domain":{"type":"string","example":"example.com","format":"domain","description":"The domain for which the system enabled DNSSEC."}},"type":"object"},"description":"An array of objects that contains information about each domain."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Security"]}]},"create_featurelist":{"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"paths":{"/create_featurelist":{"get":{"x-cpanel-available-version":"11.46","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"command":{"type":"string","example":"create_featurelist","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"properties":{"featurelist":{"example":"Arthur","description":"The feature list's name.","type":"string"}},"type":"object"}}}}}}},"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":[{"in":"query","name":"featurelist","required":"true","description":"The feature list's name.","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.","schema":{"default":"0","enum":["1","0"],"example":"1","type":"integer"},"name":"featurelistname","in":"query","required":"false"},{"name":"overwrite","in":"query","required":"false","description":"Whether to overwrite an existing feature list.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.","schema":{"type":"integer","example":"1","enum":["1","0"],"default":"0"}}],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/create_featurelist?api.version=1&featurelist=Arthur&webmail=1&changemx=1&overwrite=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Lists"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"delete_ssl_vhost":{"openapi":"3.0.2","info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"name":"cPanel Account Settings","description":"SSL Certificates / cPanel Account Settings"}],"paths":{"/delete_ssl_vhost":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"output":{"items":{"type":"string"},"description":"Shows the status of the deletion.","example":["Deleting the SSL host for example.com","Done."],"type":"array"},"removed_vhost_data":{"description":"The virtual host data that the script removed.","items":{"type":"object","properties":{"vhost_entry":{"type":"string","description":"The output text.","example":"<VirtualHost 192.0.2.0 :443>\nServerName example.com\nServerAlias [...]\n"},"servername":{"example":"example.com","format":"domain","description":"The name of the deleted domain.","type":"string"},"ip_port":{"type":"array","example":["192.0.2.0","443"],"description":"The IP address where the virtual host data resided and its port number.","items":{"type":"string"}},"primary_on_ip_port":{"type":"string","format":"domain","description":"The domain name that the removed virtual host used.","example":"example.net"},"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"}}},"type":"array"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"delete_ssl_vhost"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"82","parameters":[{"description":"The hostname whose SSL virtual host you'd like to delete.","schema":{"example":"example.com","type":"string"},"in":"query","name":"host","required":"true"}],"description":"This function deletes the SSL virtual host.","operationId":"delete_ssl_vhost","x-cpanel-api-version":"WHM API 1","summary":"Delete SSL vhost","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_ssl_vhost \\\n  host='example.com'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_ssl_vhost?api.version=1&host=example.com"}]}}},"x-tagGroups":[{"tags":["cPanel Account Settings"],"name":"SSL Certificates"}]},"export_zone_dnskey":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Zones","description":"DNS / DNS Zones"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"paths":{"/export_zone_dnskey":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  export_zone_dnskey \\\n  domain='example.com' \\\n  key_id='12345'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/export_zone_dnskey?api.version=1&domain=example.com&key_id=12345","lang":"HTTP","label":"URL"}],"tags":["DNS","DNS Zones"],"summary":"Export domain's DNSKEY record value","x-cpanel-api-version":"WHM API 1","operationId":"export_zone_dnskey","description":"This function exports a domain's DNSKEY record value.","parameters":[{"schema":{"type":"string","format":"domain","example":"example.com"},"description":"The domain from which to fetch the DNSKEY record value.","required":"true","in":"query","name":"domain"},{"required":"true","in":"query","name":"key_id","schema":{"example":"12345","type":"integer","minimum":"1"},"description":"The DNSSEC record's ID."}],"x-cpanel-available-version":"88","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"export_zone_dnskey","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"key_id":{"type":"integer","minimum":"1","example":"12345","description":"The security key's ID."},"dnskey":{"type":"string","example":"AwEAAch8SGW4vE6PjFWA9rbUm0AfTq+gJ0HC/nLu+2axdWHBIStt9lsOzKDorAr4vlmhlJzEzA62s96xp6mZ7XHUyWnkFwLs8obo6upL2in4h1ToOxzVl3lTs8O+kWtDq5/h1nwFlPDs9zpLJhlkTCtx2OTGbvimEYeqwPolUuSQR/Yb","description":"The DNSKEY record value."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}}}}}},"enable_dkim":{"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/enable_dkim":{"get":{"parameters":[{"required":"true","in":"query","name":"domain","schema":{"type":"string"},"examples":{"multiple":{"summary":"To enable multiple domain DKIM records","value":"domain=example-1.com domain=example-2.com domain=example-3.com"},"single":{"value":"example.com","summary":"To enable a single domain DKIM record"}},"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`."}],"operationId":"enable_dkim","description":"This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"example":"enable_dkim","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"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":{"status":{"type":"integer","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.","example":"1","enum":["0","1"]},"msg":{"example":"Installed Keys","description":"The domain's DKIM record status message.","type":"string"},"domain":{"example":"example.com","description":"The domain for which the system enabled the DKIM record.","format":"domain","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"78","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enable_dkim \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_dkim?api.version=1&domain=example.com","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable domain's DKIM records"}}},"x-tagGroups":[{"name":"Mail","tags":["Mail DNS Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Mail DNS Settings","description":"Mail / Mail DNS Settings"}]},"suspend_outgoing_email":{"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"paths":{"/suspend_outgoing_email":{"get":{"summary":"Suspend cPanel account outgoing email","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  suspend_outgoing_email \\\n  user='example'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/suspend_outgoing_email?api.version=1&user=example","lang":"HTTP","label":"URL"}],"tags":["Mail","cPanel Account Mail Management"],"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"suspend_outgoing_email","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"operationId":"suspend_outgoing_email","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.","parameters":[{"required":"true","in":"query","name":"user","schema":{"type":"string","example":"example"},"description":"The cPanel account.\n\n**Note**\n\nYou **cannot** suspend the `root` user's outgoing email with this function."}]}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"modifyacct":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{"IntPosOrUnlimited":{"example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}]},"Int999999OrUnlimited":{"example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"maximum":"999999","type":"integer","minimum":"0"}]}}},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/modifyacct":{"get":{"tags":["Accounts","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modifyacct \\\n  user='example'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modifyacct?api.version=1&user=example","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update cPanel account","operationId":"modifyacct","description":"This function modifies a cPanel account.\n\n**Warning:**\n\nWe **strongly** recommend that you **do not** modify a single cPanel account's settings if that cPanel 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**.\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).","parameters":[{"schema":{"type":"string","example":"example","format":"username"},"description":"The cPanel account's current username.","required":"true","in":"query","name":"user"},{"schema":{"example":"1","enum":["0","1"],"type":"integer"},"description":"Whether backups are enabled for the cPanel account.\n\n* `1` — Enable backups.\n* `0` — Disable backups.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nYou **must** have `root`-level privileges to set this parameter.","required":"false","in":"query","name":"BACKUP"},{"required":"false","in":"query","name":"BWLIMIT","schema":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"example":"unlimited"},"description":"The cPanel account's maximum bandwidth use, in bytes.\n\n* `0` or `unlimited` — The cPanel account can use unlimited bandwidth.\n\nThis parameter defaults to the defined system value."},{"in":"query","name":"contactemail","required":"false","description":"The cPanel account's contact email address.\n\nThis parameter defaults to the defined system value.","schema":{"format":"email","example":"username@example.com","type":"string"}},{"required":"false","in":"query","name":"DNS","schema":{"type":"string","example":"example.com","format":"domain"},"description":"The cPanel account's main domain.\n\nThis parameter is an alias of `domain`. If you set both\nthe `DNS` and `domain` parameters, the `DNS` parameter will\noverride the `domain` parameter.\n\nThis parameter defaults to the defined system value."},{"schema":{"example":"example.com","format":"domain","type":"string"},"description":"The cPanel account's main domain.\n\nThis parameter is an alias of `DNS`. If you set both\nthe `DNS` and `domain` parameters, the `DNS` parameter will\noverride the `domain` parameter.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"domain"},{"name":"HASCGI","in":"query","required":"false","description":"Whether CGI access is enabled for the cPanel account.\n\n* `1` — Enable CGI access.\n* `0` — Disable CGI access.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nWhen a [server profile](https://go.cpanel.net/howtouseserverprofiles) disables the Web Server role, you **cannot** enable CGI access.","schema":{"type":"integer","example":"1","enum":["0","1"]}},{"name":"HASDKIM","in":"query","required":"false","description":"Whether DKIM is enabled for the cPanel account.\n\n* `1` — Enable DKIM.\n* `0` — Disable DKIM.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["0","1"],"example":"1"}},{"in":"query","name":"HASDMARC","required":"false","description":"Whether DMARC is enabled for the cPanel account.\n\n* `1` — Enable DMARC.\n* `0` — Disable DMARC.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","example":"1","enum":["0","1"]}},{"description":"Whether shell (SSH) access is enabled for the cPanel account.\n\n* `1` — Enable shell access.\n* `0` — Disable shell access.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nWe **strongly** recommend that you use the `shell` parameter to specify a shell for SSH access.","schema":{"example":"1","enum":["0","1"],"type":"integer"},"in":"query","name":"HASSHELL","required":"false"},{"description":"Whether SPF is enabled for the cPanel account.\n\n* `1` — Enable SPF.\n* `0` — Disable SPF.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["0","1"],"example":"1"},"name":"HASSPF","in":"query","required":"false"},{"schema":{"type":"string","format":"ISO-3166-1 (alpha-2)","example":"en"},"description":"The cPanel account's default locale, in two-letter [ISO-3166 code](https://www.iso.org/iso-3166-country-codes.html) format.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"LOCALE"},{"description":"The cPanel account's maximum number of addon domains.\n\n* `0` or `unlimited` — The cPanel account can use unlimited addon domains.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"},"in":"query","name":"MAXADDON","required":"false"},{"in":"query","name":"MAXFTP","required":"false","description":"The cPanel account's maximum number of FTP accounts.\n\n* `unlimited` — The cPanel account can create unlimited FTP accounts.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"}},{"required":"false","in":"query","name":"MAXLST","schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"},"description":"The cPanel account's maximum number of mailing lists.\n\n* `0` or `unlimited` — The cPanel account can create unlimited mailing lists.\n\nThis parameter defaults to the defined system value."},{"description":"The cPanel account's maximum number of parked domains (aliases).\n\n* `unlimited` — The cPanel account can use unlimited parked domains.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"},"in":"query","name":"MAXPARK","required":"false"},{"description":"The cPanel account's maximum number of Ruby applications.\n\n* `unlimited` — The cPanel account can use unlimited Ruby applications.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"},"in":"query","name":"MAXPASSENGERAPPS","required":"false"},{"in":"query","name":"MAXPOP","required":"false","description":"The maximum number of email accounts for the cPanel account.\n\n* `unlimited` — The cPanel account can create unlimited email accounts.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"}},{"schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"},"description":"The maximum number of each available type of SQL database for\nthe cPanel account. For example, if you set this value to `5`\nand the system administrator allows MySQL® and PostgreSQL®\ndatabases, users can create up to five MySQL databases and up\nto five PostgreSQL databases.\n\n* `unlimited` — The cPanel account can create unlimited databases.\n\nThis parameter defaults to the defined system value.","required":"false","name":"MAXSQL","in":"query"},{"schema":{"$ref":"#/components/schemas/Int999999OrUnlimited"},"description":"The maximum number of subdomains for the cPanel account.\n\n* `unlimited` — The cPanel account can create unlimited subdomains.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"MAXSUB"},{"required":"false","name":"MAX_EMAIL_PER_HOUR","in":"query","schema":{"$ref":"#/components/schemas/IntPosOrUnlimited"},"description":"The maximum number of emails that the cPanel account can send in one hour.\n\n* `0` or `unlimited` — The cPanel account can send an unlimited number of emails.\n\nThis parameter defaults to the defined system value."},{"name":"MAX_EMAILACCT_QUOTA","in":"query","required":"false","description":"The maximum quota, in megabytes (MB), that the cPanel account can define\nwhen it creates an email account.\n\n* `unlimited` — The cPanel account can set unlimited quotas.\n\nThis parameter defaults to the defined system value, or to `unlimited` if you do not define either the `plan` or `MAX_EMAILACCT_QUOTA` parameters.\n\n**Important:**\n\n* This value applies to each email account, **not** each cPanel account.\n* If you specify a `MAX_EMAILACCT_QUOTA` value, the function will overwrite the plan's defined value for that cPanel\naccount.\n* We recommend that you allow the cPanel account's plan to determine this value.","schema":{"example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","maximum":"4294967296","minimum":"0"}]}},{"required":"false","in":"query","name":"update_existing_email_account_quotas","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"description":"Whether to update the quota for existing email accounts to match the value of `MAX_EMAILACCT_QUOTA` setting.\n\n* `1` — Update quota for existing email accounts.\n* `0` — Do not update quota for existing email accounts.\n\n**Important:**\n\nTo use this parameter, you **must** also use the `MAX_EMAILACCT_QUOTA` parameter."},{"required":"false","name":"MAX_DEFER_FAIL_PERCENTAGE","in":"query","schema":{"$ref":"#/components/schemas/IntPosOrUnlimited"},"description":"The percentage of failed or deferred email messages that the\ncPanel account can send per hour before outgoing mail is rate-limited.\n\n* `0` or `unlimited` — The cPanel account can send an unlimited number of failed or deferred messages.\n\nThis parameter defaults to the defined system value."},{"description":"The cPanel account's new username.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\n* Usernames **cannot** begin with a number or the string `test`.\n* Usernames can contain 16 characters or fewer if database prefixes are enabled.\n* The first eight characters of usernames **must** be unique. MySQL requires this due to potential conflicts with cPanel account transfers. However, this limit requirement does **not** exist on servers that use MariaDB.\n* If you rename the cPanel account and database prefixing is enabled, you can also use the `rename_database_objects` parameter.","schema":{"type":"string","format":"username","example":"example1"},"in":"query","name":"newuser","required":"false"},{"schema":{"type":"string","format":"username","example":"reseller_name"},"description":"A new owner's username or the `root` user, to change the cPanel account's owner.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nThe authenticated user must have `root` privileges in order to assign the cPanel account to a reseller other than that cPanel account.","required":"false","name":"owner","in":"query"},{"description":"The cPanel account's disk space quota.\n\n* An integer in multiples of 1,048,576 bytes.\n* `0` or `unlimited` — The cPanel account's disk space is unlimited.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/IntPosOrUnlimited"},"name":"QUOTA","in":"query","required":"false"},{"required":"false","name":"remove_missing_extensions","in":"query","schema":{"default":"","example":"packageext1 packageext2","type":"string"},"description":"A space-separated list of removed, missing, or uninstalled package extensions.\n\n**Warning:**\n\nThis parameter removes all of the extensions that you list from the `_PACKAGE_EXTENSIONS` variable in the user file. It will **not** remove the extensions' variables. For more information, read our [Guide to Package Extensions](https://go.cpanel.net/GuidetoPackageExtensions)."},{"description":"Whether to rename the cPanel account's database objects to use a new username's database prefix.\n\n* `1` — Rename the cPanel account's database objects.\n* `0` — Do **not** rename the cPanel account's database objects.\n\n**Warning:**\n\n* The cPanel account owner must update any applications to use the new database object names.\n* **Use this parameter carefully**, as it may cause confusion for system administrators.\n\nMySQL does not allow you to rename a database. When cPanel & WHM \"renames\" a database, the system performs the following steps:\n\n1. The system creates a new database.\n1. The system moves data from the old database to the new database.\n1. The system recreates grants and stored code in the new database.\n1. 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**Note:**\n\nThis parameter **only** applies to servers that use database prefixing.","schema":{"example":"0","enum":["0","1"],"default":"1","type":"integer"},"name":"rename_database_objects","in":"query","required":"false"},{"name":"reseller","in":"query","required":"false","description":"Whether to grant reseller privileges to the cPanel account.\n\n* `1` — Grant reseller privileges.\n* `0` — Do **not** grant reseller privileges.\n\n**Note:**\n\nYou **must** have `root`-level privileges to use this parameter.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"}},{"required":"false","name":"shell","in":"query","schema":{"type":"string","format":"path","example":"/bin/bash"},"description":"The absolute filepath to the shell's location.\n\nThis parameter defaults to the defined system value."},{"description":"Whether Apache SpamAssassin™ is enabled for the cPanel account.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","example":"0","enum":["0","1"]},"name":"spamassassin","in":"query","required":"false"},{"name":"modify_firewall","in":"query","required":"false","description":"Whether to modify the firewall rules as part of the cPanel account modification.\n\n* `1` — Modify the firewall rules.\n* `0` — Do **not** modify the firewall rules.\n\n**Note:**\n\nIf you do not set this parameter, the system will modify the firewall based on the *Do not make changes to the firewall during cPanel account modification.* setting in WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).","schema":{"example":"0","enum":["0","1"],"default":"1","type":"integer"}},{"schema":{"example":"jupiter","type":"string"},"description":"The cPanel account's cPanel theme.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"RS"},{"required":"false","name":"DBOWNER","in":"query","schema":{"type":"string","example":"example"},"description":"The owner of the cPanel account's MySQL databases.\n\nThis parameter defaults to the defined system value."},{"required":"false","name":"DISK_BLOCK_LIMIT","in":"query","schema":{"type":"integer","example":"100000000"},"description":"The number of disk blocks for the cPanel account, in kilobytes (KB).\n\nThis parameter defaults to the defined system value."},{"required":"false","name":"LANG","in":"query","schema":{"example":"english-utf8","type":"string"},"description":"The cPanel account's display language.\n\nThis parameter defaults to the defined system value."},{"description":"The storage format that the cPanel account's mailboxes use.\n\n* `maildir`\n* `mbox`\n\nThis parameter defaults to the defined system value.","schema":{"type":"string","example":"maildir","enum":["maildir","mbox"]},"in":"query","name":"MAILBOX_FORMAT","required":"false"},{"required":"false","name":"MXCHECK-*","in":"query","schema":{"type":"integer"},"description":"The priority of the cPanel account's primary mail exchanger.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nThe parameter name consists of `MXCHECK`, a hyphen, and the primary domain name of\nthe cPanel account. For example, `MXCHECK-example.com=10`."},{"schema":{"type":"integer","example":"0","enum":["0","1"]},"description":"Whether to suspend outgoing email on the cPanel account.\n\n* `1` — Suspend outgoing email.\n* `0` — Do **not** suspend outgoing email.\n\nThis parameter defaults to the defined system value.","required":"false","name":"OUTGOING_EMAIL_SUSPENDED","in":"query"},{"required":"false","in":"query","name":"PUSHBULLET_ACCESS_TOKEN","schema":{"type":"string"},"description":"An access token for the cPanel account's Pushbullet™ notifications.\n\nThis parameter defaults to the defined system value."},{"schema":{"type":"integer","enum":["0","1"],"example":"0"},"description":"Whether to send a notification when someone links the cPanel\naccount to an external authentication account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"notify_account_authn_link"},{"description":"Whether to send a notification when someone disables notifications\nfor external authentication account links.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"example":"0","enum":["0","1"],"type":"integer"},"name":"notify_account_authn_link_notification_disabled","in":"query","required":"false"},{"required":"false","name":"notify_autossl_expiry","in":"query","schema":{"type":"integer","example":"0","enum":["0","1"]},"description":"Whether to send a notification when an AutoSSL certificate expires.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value."},{"description":"Whether to send a notification AutoSSL cannot renew a certificate\nbecause domains that fail Domain Control Validation (DCV) exist on the current\ncertificate.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"example":"0","enum":["0","1"],"type":"integer"},"name":"notify_autossl_expiry_coverage","in":"query","required":"false"},{"in":"query","name":"notify_autossl_renewal","required":"false","description":"Whether to send a notification when AutoSSL renews a certificate.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["0","1"],"example":"0","type":"integer"}},{"name":"notify_autossl_renewal_coverage","in":"query","required":"false","description":"Whether to send a notification when AutoSSL renews a certificate\nbut the new certificate lacks at least one domain that the previous certificate\nsecured.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["0","1"],"example":"0"}},{"name":"notify_contact_address_change","in":"query","required":"false","description":"Whether to send a notification when someone changes the contact\naddress for the cPanel account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","example":"0","enum":["0","1"]}},{"in":"query","name":"notify_contact_address_change_notification_disabled","required":"false","description":"Whether to send a notification when disables the notification\nfor contact address changes.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["0","1"],"example":"0","type":"integer"}},{"description":"Whether to send a notification when the cPanel account reaches its disk usage limit.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["0","1"],"example":"0"},"name":"notify_disk_limit","in":"query","required":"false"},{"description":"Whether to send a notification when someone changes the cPanel account's\npassword.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"example":"0","enum":["0","1"],"type":"integer"},"in":"query","name":"notify_password_change","required":"false"},{"description":"Whether to send a notification when someone disables notifications\nfor password changes.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["0","1"],"example":"0","type":"integer"},"in":"query","name":"notify_password_change_notification_disabled","required":"false"},{"description":"Whether to send a notification when an SSL certificate on the\ncPanel account expires.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["0","1"],"example":"0","type":"integer"},"name":"notify_ssl_expiry","in":"query","required":"false"},{"in":"query","name":"STARTDATE","required":"false","description":"A timestamp to use as the cPanel account's creation date.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nThis parameter does **not** provide user access controls. For example, you cannot modify a\ncPanel account's date to prevent a user from logging in to the server.","schema":{"example":"1549471343","format":"unix_timestamp","type":"integer"}},{"description":"The cPanel account's cPanel interface theme style.\n\nThis parameter defaults to the defined system value.","schema":{"example":"Glass","type":"string"},"in":"query","name":"STYLE","required":"false"},{"schema":{"oneOf":[{"example":"mailnode","description":"A mail node alias.","type":"string"},{"type":"string","enum":[".local"],"description":"Transfer a user’s mail from an existing mail node to the local server."}],"example":"mailnode"},"description":"The server that will manage the cPanel account's mail.\n\n* `.local` — Make the local server manage the cPanel account’s mail. If the account currently uses a [child node](https://go.cpanel.net/cPanelGlossary#child-node) for its mail, this will transfer the account’s mail to the local server.\n* The alias (friendly name) of a child node that should manage the cPanel account’s mail.\n\n  When you distribute an account’s mail, the function adds a `LINK` entry to the\n  [`/var/cpanel/accounting.log`](https://go.cpanel.net/ThecPanelLogFiles) file.\n\nThis parameter defaults to the account’s current mail node, or `.local` if the account’s mail is on the local server.","required":"false","in":"query","name":"mail_node_alias"},{"in":"query","name":"account_enhancements","schema":{"type":"string"},"description":"A list of names for [Account Enhancements](https://go.cpanel.net/account-enhancements) to assign to the cPanel account.\n To view your server's Account Enhancements, run WHM API 1's `list_account_enhancements` function.\n\n**Warning:**\n\nYou must provide a complete list of Account Enhancements for the cPanel account. The parameter will add or remove Account Enhancements\nbased on the names that you provide.","examples":{"single":{"summary":"Assign one enhancement","value":"My Custom Enhancement"},"multiple":{"summary":"Assign multiple enhancements","value":["My Custom Enhancement","Sample Enhancement"]}}},{"description":"The maximum number of Team users for this account.\nThis parameter should be a number between 0 and the server's default value, inclusively.\nThis parameter can not be a number greater than the server's default value.","schema":{"type":"integer","maximum":"7","minimum":"0","example":"7"},"name":"max_team_users","in":"query","required":"false"}],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"domain":{"format":"domain","description":"The cPanel account's main domain.","example":"example.com","type":"string"},"cpuser":{"additionalProperties":{"description":"The complete attributes of the cPanel account."},"type":"object","description":"An object that contains the cPanel account's modified information.\n\n**Note:**\n\n* The possible properties in this section are the same as the possible query parameters (the attributes of the cPanel account).\n* These properties show up even if the query did **not** modify them.\n* Some of these properties **only** appear under certain other conditions.\n* If the cPanel account or its hosting plan use package extensions, the `cpuser` object will also include the extension's variables.","example":{"BWLIMIT":"0","notify_ssl_expiry":"0","HOMEDIRLINKS":[],"notify_password_change_notification_disabled":"0","OWNER":"example","notify_disk_limit":"0","HASSPF":"1","MAX_EMAILACCT_QUOTA":"unlimited","__CACHE_DATA_VERSION":"0.81","FEATURELIST":"default","_PACKAGE_EXTENSIONS":"","BACKUP":"1","RS":"jupiter","HASDMARC":"1","MXCHECK-example.com":"0","LEGACY_BACKUP":"0","notify_autossl_expiry":"0","MAXLST":"unlimited","MAXSQL":"unlimited","DBOWNER":"example","modify_firewall":"1","notify_contact_address_change":"0","MTIME":"1560518791","HASCGI":"1","HASDKIM":"1","notify_autossl_expiry_coverage":"0","MAXSUB":"unlimited","STARTDATE":"1554919365","DOMAINS":["subdomain.example.com"],"LOCALE":"en","MAX_EMAIL_PER_HOUR":"unlimited","MAXPARK":"0","MAXPOP":"unlimited","IP":"172.16.1.13","notify_account_authn_link_notification_disabled":"0","notify_autossl_renewal_coverage_reduced":"0","notify_password_change":"0","CONTACTEMAIL":"example@example.com","MAXADDON":"0","notify_autossl_renewal_coverage":"0","notify_account_authn_link":"0","PUSHBULLET_ACCESS_TOKEN":"","notify_bandwidth_limit":"0","USER":"example","MAX_DEFER_FAIL_PERCENTAGE":"unlimited","MAXFTP":"unlimited","DEMO":"0","DOMAIN":"example.com","MAILBOX_FORMAT":"maildir","DEADDOMAINS":[],"UTF8MAILBOX":"1","DISK_BLOCK_LIMIT":"0","PLAN":"default","CONTACTEMAIL2":"","notify_autossl_renewal_uncovered_domains":"0","notify_contact_address_change_notification_disabled":"0"}},"user":{"description":"The cPanel account username.\n\n**Note:**\n\nIf you changed the cPanel account's username, the function returns the new value.","format":"username","example":"example1","type":"string"},"setshell":{"description":"The absolute path to the cPanel account's shell.","format":"path","example":"/bin/bash","type":"string"}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"modifyacct","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"output":{"type":"object","properties":{"warnings":{"example":["Changing the cPanel account username from “example” to “example1” requires Digest Authentication to be disabled.","Use the Web Disk Accounts page in cPanel to re-enable Digest Authentication."],"items":{"type":"string"},"description":"Any warnings that the system generated.","type":"array"},"messages":{"type":"array","example":["Reseller data updated","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","Username changed from example to example1","Restarting apache"],"items":{"type":"string"},"description":"Any messages that the system generated."}},"description":"Output of the operation."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Account Modified","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"name":"Account Management","description":"Accounts / Account Management"}]},"list_accounts_retention":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"tags":[{"description":"The Web Log Retention module for WHM API 1.","name":"Web Log Retention"},{"name":"Logs","description":"Logs / Web Log Retention"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Logs","tags":["Web Log Retention"]}],"paths":{"/list_accounts_retention":{"get":{"tags":["Web Log Retention","Logs"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_accounts_retention\n","lang":"Shell","label":"CLI"},{"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","summary":"List accounts' web log retention settings","description":"List each cPanel account's web server log retention preference alongside the server default.","operationId":"list_accounts_retention","parameters":[],"x-cpanel-available-version":"136","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"list_accounts_retention","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.\n","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}},"type":"object"},"data":{"properties":{"accounts":{"type":"array","description":"A list of cPanel accounts and their web log retention preferences.","items":{"properties":{"retention_days":{"example":"30","description":"The account's custom web log retention period, in days.\nNull when the account uses the server default.\n","nullable":"true","type":"integer"},"using_default":{"type":"boolean","example":"false","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"},"user":{"description":"The cPanel account username.","example":"alice","type":"string"},"domain":{"type":"string","description":"The account's primary domain.","example":"example.com"}},"type":"object"}},"default_retention":{"type":"integer","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":"object"}}}}}}}}}}},"get_cphulk_brutes":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Reporting","name":"Reporting"}],"paths":{"/get_cphulk_brutes":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return login security brute force attacks","tags":["cPHulk","Reporting"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_cphulk_brutes\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_cphulk_brutes?api.version=1"}],"x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brutes":{"items":{"properties":{"exptime":{"example":"2014-12-07T00:00:00.000Z","description":"When the login request will time out.","format":"ISO-8601 Date Time (Space Separated)","type":"string"},"logintime":{"description":"When the login attempt occurred.","format":"ISO-8601 Date Time (Space Separated)","example":"2014-11-20T00:00:00.000Z","type":"string"},"timeleft":{"type":"integer","minimum":"1","example":"14","description":"The number of minutes that remain before cPHulk removes the block."},"notes":{"type":"string","description":"The login entry's notes.","example":"this was a triumph"},"ip":{"description":"The IP address of the login attempt.","example":"192.168.0.1","anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]}},"type":"object"},"description":"An array of information about each brute force attack.","type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"get_cphulk_brutes"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"description":"This function lists brute force attack entries from the cPHulk database.","operationId":"get_cphulk_brutes","parameters":[]}}},"x-tagGroups":[{"tags":["Reporting"],"name":"Login Security (cPHulk)"}]},"restore_modules_summary":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"description":"Account Restoration / Restore Queue Reporting","name":"Restore Queue Reporting"}],"paths":{"/restore_modules_summary":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"modules":{"description":"An array of objects containing information about backup configuration modules.","items":{"properties":{"module":{"description":"The module's name.","type":"string"},"notes":{"type":"array","items":{"type":"string"},"description":"Notes about the module, if any exist."},"restricted_available":{"enum":["1","0"],"description":"Whether the module is available under a\n[restricted restore](https://go.cpanel.net/whmdocsTransferorRestoreacPanelAccount#restricted-restore).\n\n* `1` — The module is available under a restricted restore.\n* `0` — The module is **not** available under a restricted restore.","type":"integer"},"summary":{"items":{"type":"string"},"description":"A description of the module's behavior when the transfer does **not** use a restricted restore.","type":"array"},"restricted_summary":{"type":"array","items":{"type":"string"},"description":"A description of the module's behavior when the transfer uses a restricted restore."}},"type":"object"},"type":"array"}},"type":"object","example":{"modules":[{"summary":["The APITokens module restores the API tokens for an account."],"restricted_available":"1","module":"APITokens"},{"restricted_available":"1","module":"Account","restricted_summary":["Force mode is not available in restricted mode."],"summary":["This creates the cPanel account and system user."]},{"summary":["This restores the account’s external authentication links."],"module":"AuthnLinks","restricted_available":"1"},{"restricted_available":"1","module":"AutoSSL","summary":["This restores AutoSSL settings."]},{"summary":["This installs the backup configuration based on the target system’s defaults."],"restricted_available":"1","module":"BackupConfig"},{"summary":["This restores the bandwidth data."],"module":"BandwidthData","restricted_available":"1"},{"restricted_available":"1","module":"CpUser","restricted_summary":["The system discards configuration data that is unknown or that the system cannot validate."],"summary":["This restores the cPanel account’s configuration data."]},{"summary":["This restores crontab entries."],"module":"Cron","restricted_available":"1"},{"summary":["This restores custom locales."],"restricted_available":"0","module":"CustomLocale"},{"module":"DKIM","restricted_available":"1","summary":["This restores DKIM (DomainKeys Identified Mail) keys and updates records for the current server."]},{"summary":["This module reports whether this system is authoritative for each of the new accounts’ DNS (Domain Name System) zones."],"module":"DNSAuthority","restricted_available":"1"},{"summary":["This module restores the DNSSEC keys for an account."],"restricted_available":"1","module":"DNSSEC"},{"module":"DigestShadow","restricted_available":"1","summary":["This restores password data for digest authentication."]},{"restricted_summary":["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."],"summary":["This restores subdomains, parked domains, and addon domains."],"restricted_available":"1","module":"Domains"},{"restricted_available":"1","module":"FeatureList","summary":["This restores the account’s feature list setting."]},{"summary":["This configures the account for cPanel FileProtect."],"restricted_available":"1","module":"FileProtect"},{"restricted_available":"1","module":"Ftp","summary":["This restores FTP (File Transfer Protocol) accounts."]},{"summary":["This restores the home directory’s contents."],"restricted_summary":["If the home directory does not already exist, the system will not create it."],"module":"Homedir","restricted_available":"1"},{"module":"Htaccess","restricted_available":"1","summary":["This repairs EasyApache4 and removes legacy Frontpage entries from .htaccess."]},{"summary":["This sets up a dedicated IP address."],"restricted_available":"1","module":"IPAddress"},{"restricted_available":"0","module":"Integration","summary":["Implementor Error: The summary for this module is missing."]},{"summary":["This module handles the linked node setup."],"restricted_available":"1","module":"LinkedNodes"},{"restricted_available":"1","module":"LinkedNodesSubarchives","summary":["This module restores linked-node configurations when the archive contains linked node data."]},{"module":"LocalConfig","restricted_available":"1","summary":["This module updates the local user’s configuration."]},{"restricted_available":"1","module":"Logs","summary":["This restores service access logs."]},{"summary":["This resets email quotas to safe values and restores email aliases, filters and mail items."],"restricted_available":"1","module":"Mail"},{"module":"MailFix","restricted_available":"1","summary":["This repairs mail permissions and upgrades the system to the latest storage methods."]},{"restricted_available":"1","module":"MailLimits","summary":["This restores any holds or suspensions on outgoing messages for a user’s email accounts."]},{"summary":["This updates MX (Mail eXchange) records."],"restricted_available":"1","module":"MailRouting"},{"summary":["This copies any new mail to the local server that the remote account received during the transfer."],"module":"MailSync","restricted_available":"1"},{"module":"Mailman","restricted_available":"1","summary":["This restores mailing lists."]},{"summary":["This configures the source server’s manual MX entries to send mail to the destination server."],"restricted_available":"1","module":"ManualMX"},{"module":"Mysql","restricted_available":"1","summary":["This restores MariaDB/MySQL databases, users, and grants."]},{"summary":["The MysqlRemoteNotes module restores the Remote MySQL comments for an account."],"restricted_available":"1","module":"MysqlRemoteNotes"},{"module":"NobodyFiles","restricted_available":"1","summary":["This restores ownership of files previously owned by the “nobody” user in the home directory."]},{"summary":["This creates symbolic links to former home directory paths."],"restricted_available":"0","module":"OldHomedirs","notes":["Symbolic links for former home directories ensure that applications with hard-coded paths continue to work when transferred between servers."]},{"summary":["This recreates account packages."],"notes":["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."],"module":"Package","restricted_available":"0"},{"summary":["This restores the encrypted system password."],"restricted_available":"1","module":"Password"},{"summary":["This runs post-restoration actions and cleanups."],"module":"PostRestoreActions","notes":["This module updates system databases and name server IP address lists, restarts services, unblocks dynamic content, and runs custom post-restoration scripts."],"restricted_available":"1"},{"module":"Postgres","restricted_available":"0","summary":["This restores PostgreSQL databases, users, and grants."],"restricted_summary":["PostgreSQL version “8.4” or later is required to restore databases in restricted mode."]},{"summary":["This performs pre-restoration actions and cleanups."],"restricted_available":"1","notes":["This module temporarily lifts the account’s quota and runs custom pre-restoration scripts."],"module":"PreRestoreActions"},{"restricted_available":"1","module":"ProxySubdomains","notes":["This module ensures that service subdomains such as “cpanel”, “cpcalendars”, and “cpcontacts” are configured properly."],"summary":["This restores service subdomains."]},{"restricted_available":"1","module":"PublicContact","summary":["This restores the account’s public contact data."]},{"summary":["This creates symbolic links to former web root directory paths."],"restricted_summary":["The system does not recreate symbolic links outside of the account’s home directory in restricted mode."],"notes":["Symbolic links for former web root directories ensure that applications with hard-coded paths will continue to work when transferred between servers."],"module":"PublicHtmlSymlinks","restricted_available":"1"},{"module":"PublishZones","restricted_available":"1","summary":["This module ensures all zones have been synced out and reloaded across the DNS (Domain Name System) cluster."]},{"module":"Quota","restricted_available":"1","summary":["This restores the account’s data storage quota."]},{"restricted_available":"0","module":"Reseller","notes":["This restores all of the privileges the account previously had. This includes the “all” privilege, which is equivalent to root access."],"summary":["This restores reseller privileges."]},{"module":"ResyncHomedir","restricted_available":"1","summary":["This module will resynchronize the home directory from the source server. The module preserves any changes that occurred during the transfer."],"restricted_summary":["If the home directory does not already exist, the system will not create it."]},{"summary":["This restores Roundcube configuration and preferences."],"module":"Roundcube","restricted_available":"1"},{"summary":["This restores SPF (Sender Policy Framework) records and updates them for the target server."],"module":"SPF","restricted_available":"1"},{"summary":["This restores SSL (Secure Sockets Layer) keys, certificates, and virtual host entries."],"module":"SSL","restricted_available":"1"},{"module":"ServiceProxy","restricted_available":"1","summary":["This module sets up applicable service proxying to the destination servers."]},{"summary":["This restores the account’s shell."],"restricted_summary":["In restricted mode, the system will set any account that requests a shell other than “noshell” or “jailshell” to use “jailshell”."],"module":"Shell","restricted_available":"1"},{"summary":["This module will disable SpamAssassin for the restored user if they had it enabled at the source."],"module":"SpamAssassin","restricted_available":"0"},{"summary":["Implementor Error: The summary for this module is missing."],"restricted_available":"0","module":"Subaccount"},{"restricted_available":"1","module":"Suspend","restricted_summary":["The system will not restore the suspension reason or old shell for the account and instead will use a default."],"summary":["This module will suspend the restored user if they were suspended at the source."]},{"restricted_available":"1","module":"Unsuspend","summary":["This unsuspends .htaccess files."]},{"summary":["This restores custom virtual host includes."],"module":"VhostIncludes","restricted_available":"0"},{"module":"Vhosts","restricted_available":"1","summary":["This module installs the web server configuration and restarts the web server."]},{"restricted_available":"1","module":"WebCalls","summary":["This module restores the account’s web call data."]},{"summary":["This rewrites web disk home directories to the correct location on the new server."],"restricted_available":"1","module":"WebDiskHomedir"},{"summary":["This restores custom DNS (Domain Name System) Zone entries."],"restricted_available":"1","module":"ZoneFile"},{"summary":["This restores website configuration (userdata)."],"restricted_summary":["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."],"module":"userdata","restricted_available":"1"}]}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"command":{"example":"restore_modules_summary","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.50","parameters":[],"description":"This function lists backup modules and their descriptions.","operationId":"restore_modules_summary","x-cpanel-api-version":"WHM API 1","summary":"Return backup modules list","tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_modules_summary\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_modules_summary?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"tags":["Restore Queue Reporting"],"name":"Account Restoration"}]},"is_https_available":{"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"cPanel L.L.C."},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.121.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"paths":{"/is_https_available":{"get":{"description":"This function fetches information regarding HTTPS records support.\nHTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints.\nFor more information, read our [HTTPS record documentation](https://go.cpanel.net/dns-https-record).","operationId":"is_https_available","tags":["DNS","Domain Management","Service Records"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  is_https_available\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/is_https_available?api.version=1"}],"x-cpanel-available-version":"cPanel 122","x-cpanel-api-version":"WHM API 1","summary":"Return HTTPS DNS record support information","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"is_https_available","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"https":{"description":"Whether HTTPS records are supported.\n* `1` - Supported.\n* `0` - Not supported.","enum":["1","0"],"example":"1","type":"integer"},"dns_server":{"description":"The DNS server type currently in use (bind, pdns, etc.).","example":"pdns","type":"string"}},"type":"object"}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Domain Management","Service Records"],"name":"DNS"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / Domain Management","name":"Domain Management"},{"name":"Service Records","description":"DNS / Service Records"}]},"link_user_authn_provider":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/link_user_authn_provider":{"get":{"x-codeSamples":[{"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","lang":"Shell","label":"CLI"},{"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"}],"tags":["Authentication","External Authentication"],"summary":"Add identity provider to cPanel account","x-cpanel-api-version":"WHM API 1","parameters":[{"description":"The account's username.","schema":{"example":"example","format":"username","type":"string"},"name":"username","in":"query","required":"true"},{"description":"The name of the identity provider.","schema":{"type":"string","example":"google"},"in":"query","name":"provider_id","required":"true"},{"name":"subject_unique_identifier","in":"query","required":"true","description":"The unique identifier for the user at the identity provider.","schema":{"type":"string","example":"123456789012345678901"}},{"required":"true","name":"preferred_username","in":"query","schema":{"example":"Example","type":"string"},"description":"The preferred username of the account on the identity provider."}],"operationId":"link_user_authn_provider","description":"This function adds an External Authentication authorization link to an account.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"link_user_authn_provider","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"56"}}},"x-tagGroups":[{"name":"Authentication","tags":["External Authentication"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"External Authentication","description":"Authentication / External Authentication"}]},"suspendacct":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Suspensions"],"name":"Accounts"}],"paths":{"/suspendacct":{"get":{"summary":"Suspend cPanel account","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  suspendacct \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/suspendacct?api.version=1&user=username","lang":"HTTP","label":"URL"}],"tags":["Suspensions"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"suspendacct","description":"The method name called.","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"output":{"type":"object","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"}},"description":"System messages generated while suspending the account."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"schema":{"example":"username","type":"string"},"description":"The account to suspend.","required":"true","in":"query","name":"user"},{"required":"false","in":"query","name":"reason","schema":{"example":"Nonpayment","default":"Unknown","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."},{"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.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"name":"disallowun","in":"query","required":"false"},{"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.","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"in":"query","name":"leave-ftp-accts-enabled","required":"false"}],"operationId":"suspendacct","description":"This function suspends an account."}}},"tags":[{"description":"Accounts / Suspensions","name":"Suspensions"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}]},"modsec_update_vendor":{"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"paths":{"/modsec_update_vendor":{"get":{"tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_update_vendor \\\n  url='http://example.com/update/meta_MyVendor.yaml'\n","lang":"Shell","label":"CLI"},{"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","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update ModSecurity vendor ruleset","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":[{"required":"true","in":"query","name":"url","schema":{"example":"http://example.com/update/meta_MyVendor.yaml","format":"url","type":"string"},"description":"The vendor metadata file's URL."}],"x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"vendor":{"description":"A list of updated vendor information.","type":"object","properties":{"report_url":{"example":"http://example.com/report/","format":"url","description":"The URL that the vendor uses to receive problem reports.","type":"string"},"description":{"type":"string","example":"This is an example of a custom vendor set (updated).","description":"The vendor's description."},"installed":{"type":"integer","description":"Whether the vendor is installed.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":["1","0"],"example":"1"},"vendor_url":{"type":"string","format":"url","description":"The URL to the vendor's website.","example":"http://example.com/"},"name":{"type":"string","description":"The vendor's name.","example":"My Vendor"},"installed_from":{"description":"The URL to the vendor's metadata file.","format":"url","example":"http://example.com/update/meta_MyVendor.yaml","type":"string"},"path":{"type":"string","description":"The file path to the vendor's ModSecurity configuration files.","example":"/usr/local/apache/conf/modsec_vendor_configs/MyVendor"},"cpanel_provided":{"enum":["1","0"],"example":"0","description":"Whether WebPros International, LLC provided the rule set.\n\n* `1` — Provided by WebPros International, LLC.\n* `0` — Not provided WebPros International, LLC.","type":"integer"},"enabled":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether the vendor is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/MD5) checksum value.","example":"ecafce1bf148532250a8d4743a8374d1","type":"string"},"inst_dist":{"description":"The unique identifier for the rule set version.","example":"MyVendor-2","type":"string"},"vendor_id":{"type":"string","description":"The vendor's unique short name.","example":"MyVendor"},"archive_url":{"type":"string","format":"url","description":"The URL to download the vendor rules.","example":"http://example.com/update/MyVendor.zip"}}},"diagnostics":{"type":"object","properties":{"new_configs":{"items":{"properties":{"active":{"type":"integer","enum":["1","0"],"example":"0","description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active."},"config":{"type":"string","example":"modsec_vendor_configs/MyVendor/two.conf","description":"The file path to the configuration file, relative to the `/usr/local/apache/conf/` Apache configuration directory."},"vendor_id":{"example":"MyVendor","description":"The vendor's unique name.","type":"string"}},"type":"object"},"description":"A complete list of configuration files that the update modified.","type":"array"},"deleted_configs":{"type":"array","description":"An array of objects containing the ModSecurity configuration files that the update removed.","items":{"example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"}},"added_configs":{"items":{"type":"string","example":"modsec_vendor_configs/MyVendor/three.conf"},"description":"A list of the ModSecurity configuration files that the update added.","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"}},"description":"A list of diagnostic information about the update."}}},"metadata":{"properties":{"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"modsec_update_vendor","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}}}}},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"openapi":"3.0.2"},"disable_autossl":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"paths":{"/disable_autossl":{"get":{"description":"This function disables the AutoSSL feature.","operationId":"disable_autossl","parameters":[],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"disable_autossl"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  disable_autossl\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_autossl?api.version=1","label":"URL","lang":"HTTP"}],"tags":["SSL","Auto-Generated Certificates"],"summary":"Disable AutoSSL","x-cpanel-api-version":"WHM API 1"}}}},"commit_services_cluster_inventory":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"ServicesCluster","description":"The ServicesCluster module for WHM API 1."},{"name":"ServicesCluster","description":"ServicesCluster"}],"paths":{"/commit_services_cluster_inventory":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Commit services cluster nodes into Ansible inventory.","tags":["ServicesCluster"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  commit_services_cluster_inventory\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/commit_services_cluster_inventory","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.110","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"inventory":{"example":"/etc/cpanel/services-cluster/ansible/inventory.ini","format":"path","description":"The path to the inventory file that has been written.","type":"string"}}},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"commit_services_cluster_inventory","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"description":"This function commits staged Services Cluster nodes into the Ansible inventory file.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","operationId":"commit_services_cluster_inventory","x-cpanel-internal-only":"true","parameters":[]}}},"x-tagGroups":[{"name":"ServicesCluster","tags":["ServicesCluster"]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"suspendreseller":{"x-tagGroups":[{"name":"Resellers","tags":["Reseller Account Management"]}],"paths":{"/suspendreseller":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"output":{"properties":{"raw":{"type":"string","description":"The raw output from the function."}},"type":"object"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"example":"suspendreseller","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","format":"username","example":"username"},"description":"The reseller's username."},{"description":"The reason for the reseller's suspension.\n\n**Note:**\n\n We **strongly** recommend that you **always** include a reason for suspension.","schema":{"type":"string","example":"Nonpayment"},"name":"reason","in":"query","required":"false"},{"required":"false","in":"query","name":"reseller-only","schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"},"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":"disallow","required":"false","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.","schema":{"example":"0","enum":["0","1"],"default":"0","type":"integer"}}],"description":"This function suspends a reseller account.","operationId":"suspendreseller","summary":"Suspend reseller","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  suspendreseller \\\n  user='username'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/suspendreseller?api.version=1&user=username","lang":"HTTP","label":"URL"}],"tags":["Resellers","Reseller Account Management"]}}},"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"description":"Resellers / Account Management","name":"Reseller Account Management"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"openapi":"3.0.2"},"check_remote_ssh_connection":{"x-tagGroups":[{"name":"Authentication","tags":["SSH Keys and Connections"]}],"paths":{"/check_remote_ssh_connection":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  check_remote_ssh_connection \\\n  host='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/check_remote_ssh_connection?api.version=1&host=example.com","lang":"HTTP","label":"URL"}],"tags":["SSH Keys and Connections"],"summary":"Validate SSH connection to another server","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","name":"host","in":"query","schema":{"type":"string","format":"domain","example":"example.com"},"description":"The remote server's hostname."},{"required":"false","in":"query","name":"port","schema":{"example":"22","default":"22","minimum":"1","type":"integer"},"description":"The remote server's port number."}],"description":"This function tests an SSH connection to another server.","operationId":"check_remote_ssh_connection","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"comment":{"example":"null","description":"The remote connection's comment section.\n* A valid string.\n* `undef` - If the local and remote servers connect successfully.","type":"string"},"received":{"type":"string","example":"SSH-2.0-OpenSSH_5.3","description":"The raw data from the remote server."},"server_software":{"type":"string","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"},"protocol_versions":{"items":{"example":"2.0","type":"string"},"description":"The available SSH protocol versions.\n* A valid string.\n* `undef` - If the local and remote servers connect successfully.","type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"description":"The method name called.","example":"check_remote_ssh_connection","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"tags":[{"name":"SSH Keys and Connections","description":"Authentication / SSH Keys and Connections"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"ipv6_range_list":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"description":"IP Address Management / IPv6 Address Settings","name":"IPv6 Address Settings"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["IPv6 Address Settings"],"name":"IP Address Management"}],"paths":{"/ipv6_range_list":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  ipv6_range_list\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_list?api.version=1","lang":"HTTP","label":"URL"}],"tags":["IP Addresses","IPv6 Address Settings"],"summary":"Return available IPv6 address ranges","x-cpanel-api-version":"WHM API 1","parameters":[],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"range":{"items":{"properties":{"last":{"format":"ipv6","description":"The last IPv6 address in the range.","example":"2001:db8:0100:0006:ffff:ffff:ffff:ffff","type":"string"},"note":{"example":"This is used for development.","description":"The IPv6 address range's note.","type":"string"},"name":{"example":"test_range","description":"The IPv6 address range's name.\n\n**Note:**\n\n`SHARED` represents the server's main IPv6 address.","type":"string"},"owner":{"example":"root","format":"username","description":"The user who owns the IPv6 address range.","type":"string"},"range_users":{"type":"array","description":"The user or users who use addresses in the IPv6 address range.","items":{"type":"string","format":"username","example":"user1"}},"CIDR":{"type":"string","description":"The IPv6 address range, in CIDR format.","example":"2001:db8:100:6::/64"},"mostrecent":{"format":"ipv6","description":"The most recently assigned address from the IPv6 address range.","example":"2001:db8:0100:0006:0000:0000:0002:00ce","type":"string"},"first":{"example":"2001:db8:0100:0006:0000:0000:0000:0000","description":"The first IPv6 address in the range.","format":"ipv6","type":"string"},"reclaimed":{"items":{"type":"string","example":"2001:db8:0100:0006:0000:0000:0000:0002","format":"ipv6"},"description":"IPv6 addresses within the range which have become available.","type":"array"},"enabled":{"description":"Whether the IPv6 address range is available.\n* `1`  Available.\n* `0`  Reserved.","example":"1","enum":["0","1"],"type":"integer"}},"type":"object"},"description":"An array of the IPv6 address ranges.","type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","description":"The method name called.","example":"ipv6_range_list"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.40"}}}},"modsec_set_config_text":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Server Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_set_config_text":{"get":{"tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","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"},{"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","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update ModSecurity configuration file","operationId":"modsec_set_config_text","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.","parameters":[{"name":"config","in":"query","required":"true","description":"The configuration file name.","schema":{"example":"modsec2.example.conf","type":"string"}},{"required":"true","in":"query","name":"text","schema":{"type":"string","example":"SecRule REQUEST_URI \"example\" \"deny,id:123456789\" SecAction \"pass,auditlog,id\""},"description":"The configuration text."}],"x-cpanel-available-version":"11.46","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"modsec_set_config_text","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}}}}}},"get_remote_access_hash":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"API Authentication","description":"Integrations / API Authentication"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["API Authentication"],"name":"Integrations"}],"paths":{"/get_remote_access_hash":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"get_remote_access_hash","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"accesshash":{"example":"6b355856c00606648b803a7d896186632472d584eaf0dad878b8885e1f64edad24b31ff79f2675303a598ac211ad5188c589fb60c5786a3e8d85c2029ca4ea76edb62becff7e3f7c5421f51bb4896737c22eda761e2a6fd96404bf513ee9051480ea86c800ab9b45f5255590836c7b769816a8f7f5def1e0c6cb19c212f01f56bb3392854ce51178a943eab6d1ce5d44857e980f70724f50964d2fbe01cb076a119dc5bf421051c2a0882550cdc69872832167c91e11bbe5c95d98474096ebe14b6ca9da2d73faecea5ec37f208912f5da578d5f8ab7c257584002e1808614f9859dceae564e8f30a9790c232d005ebd44f912e20b72e731fc600156e5b9f2902b0dd913010022e6b0deb6a2fb0d38ff3fd005c53f321ec812d3be10643dce81c46e1b9e2abe8814d46ba49b8a173b3e01ec677ea182cabb55db6d9eab2240755be1bbb1d7094a155fd262934ec099fdba3b10f409dced62d3d570ab6478a269a95da1314a45a5916da07312bf7e5a53d57b090e9c24932776f7ffdcf90ba2fa5cd935995795348b67311185f54da6b90da8771585e78c5f587e427bead9198faaa631b8216099c25373c8d4c26a011f295188963840777d09d95b6385df8337098b7e231534323457b9388fe9ea8046","description":"The account's remote access hash.","type":"string"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11","parameters":[{"schema":{"example":"user","type":"string"},"description":"The user's username.","required":"true","in":"query","name":"username"},{"required":"false","in":"query","name":"generate","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"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."},{"schema":{"example":"123456luggage","type":"string"},"description":"The user's password.","required":"true","in":"query","name":"password"},{"required":"true","name":"host","in":"query","schema":{"type":"string","example":"hostname.example.com"},"description":"The server's hostname."}],"operationId":"get_remote_access_hash","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.","summary":"Return remote access file's hash","x-cpanel-api-version":"WHM API 1","deprecated":"true","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_remote_access_hash \\\n  username='user' \\\n  password='123456luggage' \\\n  host='hostname.example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_remote_access_hash?api.version=1&username=user&password=123456luggage&host=hostname.example.com","lang":"HTTP","label":"URL"}],"tags":["Server Administration","API Authentication"]}}}},"setupreseller":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/setupreseller":{"get":{"parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"username","format":"username"},"description":"The account's username."},{"required":"false","in":"query","name":"makeowner","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"description":"Whether to set the account to own itself.\n* `1` — Make the account own itself.\n* `0` — Keep the account's current owner."}],"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","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"example":"setupreseller","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  setupreseller \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/setupreseller?api.version=1&user=username","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable cPanel account's reseller status"}}},"x-tagGroups":[{"name":"Resellers","tags":["Reseller Account Management"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"name":"Reseller Account Management","description":"Resellers / Account Management"}]},"get_autossl_user_excluded_domains":{"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"paths":{"/get_autossl_user_excluded_domains":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return all AutoSSL-excluded domains","tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_autossl_user_excluded_domains \\\n  username='example'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_user_excluded_domains?api.version=1&username=example","label":"URL","lang":"HTTP"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"payload":{"type":"array","items":{"properties":{"excluded_domain":{"type":"string","example":"cpcalendars.example.com","description":"A list of domains excluded from AutoSSL.","format":"domain"}},"type":"object"},"description":"An array of objects that contain a list of domains excluded from AutoSSL."}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"command":{"type":"string","description":"The method name called.","example":"get_autossl_user_excluded_domains"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"66","parameters":[{"description":"The cPanel user's account.","schema":{"example":"example","format":"username","type":"string"},"name":"username","in":"query","required":"true"}],"operationId":"get_autossl_user_excluded_domains","description":"This function lists an account's domains the system excludes from AutoSSL."}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_mailbox_status":{"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/get_mailbox_status":{"get":{"summary":"Return cPanel account mailboxes status by name","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_mailbox_status \\\n  account='user@example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_mailbox_status?api.version=1&account=user%40example.com"}],"tags":["Mail","cPanel Account Mail Management"],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","example":"get_mailbox_status","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"}}},"data":{"additionalProperties":{"type":"object","properties":{"guid":{"type":"string","example":"1234560f0c58d158c92a000044f0d230","description":"The mailbox globally unique identifier (GUID)."},"vsize":{"example":"0","description":"The total virtual size of the mailbox's contents with `CRLF` line terminators.","format":"bytes","type":"integer","minimum":"0"},"messages":{"description":"The total number of messages in the mailbox.","example":"0","minimum":"0","type":"integer"}},"description":"An object containing information about the mailbox's contents.\n\n**Note:**\n\nThe mailbox name is the return's name."},"type":"object","example":{"INBOX.Sent":{"messages":"1","vsize":"56","guid":"1111111234560f0c58d158c92a000004"},"INBOX":{"vsize":"42","guid":"111111234560f0c58d158c92a000044f","messages":"42000"},"INBOX.robert_paulsen@example_com":{"vsize":"2222","guid":"111111111234560f0c58d158c92a0001","messages":"2"},"INBOX.marla_singer@example_com":{"messages":"5","guid":"1234560f0c58d158c92a000044f0d230","vsize":"100"},"INBOX.Trash":{"guid":"1111234560f0c58d158c92a000044f0d","vsize":"5643","messages":"2001"},"INBOX.angel_face@example_com":{"messages":"3","guid":"11234560f0c58d158c92a000044f0d23","vsize":"1524"},"INBOX.narrator@example_com":{"vsize":"0","guid":"11111234560f0c58d158c92a000044f0","messages":"0"},"INBOX.Drafts":{"messages":"5","guid":"11111111234560f0c58d158c92a00000","vsize":"522"},"INBOX.tyler_durden@example_com":{"messages":"55","guid":"111234560f0c58d158c92a000044f0d2","vsize":"12244"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"get_mailbox_status","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.","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.)","schema":{"oneOf":[{"type":"string","format":"email"},{"format":"username","type":"string"}],"example":"user@example.com"},"in":"query","name":"account","required":"true"}]}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"cPanel Account Mail Management","description":"Mail / cPanel Account Mail Management"}]},"set_autossl_provider":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"paths":{"/set_autossl_provider":{"get":{"operationId":"set_autossl_provider","description":"This function sets the provider that the AutoSSL feature uses.\n\n**Note:**\n\n  To disable AutoSSL, call WHM API 1's `disable_autossl` function.","parameters":[{"description":"The AutoSSL provider's name. For example:\n* `cPanel`\n* `LetsEncrypt`","schema":{"example":"cPanel","type":"string"},"in":"query","name":"provider","required":"true"},{"name":"x_*","in":"query","required":"false","description":"Additional parameters which you wish to pass to the AutoSSL provider.\n\n  **Note:**\n\n  These additional parameters begin with the  `x_`  prefix. For example, the Let's Encrypt provider accepts the `x_terms_of_service_accepted parameter`, to which you would pass the URL of the terms of service that you accept.","schema":{"example":"(varies)","type":"string"}}],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"set_autossl_provider","description":"The method name called.","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."}}}}}}},"description":"HTTP Request was successful."}},"tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  set_autossl_provider \\\n  provider='cPanel'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_provider?api.version=1&provider=cPanel"}],"x-cpanel-api-version":"WHM API 1","summary":"Update the AutoSSL provider"}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"get_public_contact":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"tags":["Account Settings"],"name":"Resellers"}],"paths":{"/get_public_contact":{"get":{"tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_public_contact\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_public_contact?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return current user's public contact information","parameters":[],"operationId":"get_public_contact","description":"This function retrieves an account's [public contact information](https://docs.cpanel.net/whm/cpanel/customization/#public-contact).","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":{"type":"string","description":"The public contact URL.","format":"url","example":"https://bobshosting.net"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"get_public_contact","description":"The method name called.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"68"}}},"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"description":"Resellers / Account Settings","name":"Account Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"validate_exim_configuration_syntax":{"paths":{"/validate_exim_configuration_syntax":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"An object containing a valid or invalid Exim configuration information.","anyOf":[{"properties":{"error_line":{"description":"The first line in the Exim configuration file that contains an error.","type":"integer","minimum":"1"},"error_msg":{"description":"Any error messages that the validation script encountered.","type":"string"},"broken_cfg_html":{"type":"string","example":"RAW_CONFIGURATION_TEXT\n","description":"The line with the broken configuration, in HTML format.","format":"HTML"},"broken_cfg_text":{"type":"string","format":"HTML","description":"The line that includes the broken configuration.","example":"==>RAW_CONFIGURATION_TEXT<==\n"}},"type":"object","description":"The function returns this object for an invalid Exim configuration."},{"properties":{"exim_caps":{"description":"The function returns this object for a valid Exim configuration.","properties":{"passwd":{"type":"integer","description":"Whether the server supports password authentication.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":["1","0"]},"rewrite_from_all":{"enum":["1","0"],"description":"Whether the server supports the rewrite function on all incoming\nmail.\n\n* `1` — Supports.\n* `0` — Does **not** support.","type":"integer"},"maildir":{"type":"integer","enum":["1","0"],"description":"Whether the server supports the Maildir format.\n\n* `1` — Supports.\n* `0` — Does **not** support."},"no_forward_outbound_spam":{"enum":["1","0"],"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.","type":"integer"},"domainkeys":{"description":"Whether the server supports DKIM.\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"},"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"},"mailman":{"type":"integer","description":"Whether the server supports the Mailman feature.\n\n* `1` — Supports.\n*  `0` — Does **not** support.","enum":["1","0"]},"spf":{"type":"integer","enum":["1","0"],"description":"Whether the server supports SPF checks.\n\n* `1` — Supports.\n* `0` — Does **not** support."},"notquit":{"type":"integer","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"]},"dkim":{"type":"integer","description":"Whether the server supports DomainKeys Identified Mail (DKIM).\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":["1","0"]},"force_command":{"enum":["1","0"],"description":"Whether the server supports the `force_command` directive for\npipe transports.\n\n* `1` — Supports.\n* `0` — Does **not** support.","type":"integer"},"directives":{"description":"A list of individual Exim directives.","additionalProperties":{"type":"integer","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":"object"},"srs":{"type":"integer","description":"Whether the server supports the Sender Rewriting Scheme (SRS).\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":["1","0"]},"rewrite_from_remote":{"enum":["1","0"],"description":"Whether the server can rewrite the outgoing `From:` header to the\nactual sender.\n\n* `1` — Can rewrite.\n* `0` — **Cannot** rewrite.","type":"integer"},"no_forward_outbound_spam_over_int":{"type":"integer","enum":["1","0"],"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."},"dovecot":{"enum":["1","0"],"description":"Whether the server supports Dovecot authentication.\n\n* `1` — Supports.\n* `0` — Does **not** support.","type":"integer"},"exiscan":{"enum":["1","0"],"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.","type":"integer"},"content_scanning":{"enum":["1","0"],"description":"Whether the server supports content scanning functionality.\n\n* `1` — Supports.\n* `0` — Does **not** support.","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"}}}},"type":"object"}],"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"validate_exim_configuration_syntax","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"output":{"type":"string","description":"The function's raw HTML output, if any exists.","format":"HTML"}}}}},"examples":{"exim_caps":{"summary":"A valid Exim configuration.","value":{"output":{"raw":"\n"},"reason":"OK","version":"1","command":"validate_exim_configuration_syntax","data":{"exim_caps":{"maildir":"1","no_forward_outbound_spam":"1","domainkeys":"0","boxtrapper":"1","passwd":"1","rewrite_from_all":"0","add_header":"1","directives":{"unknown_login":"1","srs_hashlength":"1","tls_crl":"1","acl_smtp_helo":"1","gnutls_require_kx":"1","ignore_bounce_errors_after":"1","recipients_max_reject":"1","queue_only":"1","tls_verify_certificates":"1","auto_thaw":"1","drop_cr":"1","gnutls_require_mac":"1","sqlite_lock_timeout":"1","acl_smtp_rcpt":"1","bounce_return_size_limit":"1","tls_dh_max_bits":"1","ignore_fromline_hosts":"1","srs_usetimestamp":"1","tls_on_connect_ports":"1","helo_accept_junk_hosts":"1","smtp_ratelimit_mail":"1","callout_domain_negative_expire":"1","tls_remember_esmtp":"1","gnutls_allow_auto_pkcs11":"1","system_filter_pipe_transport":"1","queue_only_file":"1","tcp_nodelay":"1","acl_smtp_expn":"1","callout_negative_expire":"1","daemon_smtp_ports":"1","dsn_advertise_hosts":"1","smtp_accept_max_nonmail":"1","preserve_message_logs":"1","queue_run_in_order":"1","acl_not_smtp_mime":"1","system_filter_directory_transport":"1","strip_excess_angle_brackets":"1","srs_maxage":"1","rfc1413_hosts":"1","freeze_tell":"1","uucp_from_pattern":"1","tls_privatekey":"1","split_spool_directory":"1","log_timezone":"1","local_from_check":"1","smtp_accept_keepalive":"1","smtp_return_error_details":"1","prdr_enable":"1","hosts_connection_nolog":"1","deliver_queue_load_max":"1","system_filter_reply_transport":"1","envelope_to_remove":"1","srs_config":"1","syslog_timestamp":"1","callout_domain_positive_expire":"1","percent_hack_domains":"1","admin_groups":"1","acl_smtp_predata":"1","spamd_address":"1","system_filter_user":"1","acl_not_smtp_start":"1","smtp_accept_queue_per_connection":"1","errors_reply_to":"1","unknown_username":"1","gecos_name":"1","trusted_users":"1","av_scanner":"1","write_rejectlog":"1","tls_certificate":"1","local_sender_retain":"1","never_users":"1","tls_try_verify_hosts":"1","mua_wrapper":"1","smtp_max_unknown_commands":"1","sender_unqualified_hosts":"1","acl_smtp_auth":"1","smtp_accept_max_nonmail_hosts":"1","srs_usehash":"1","smtp_max_synprot_errors":"1","allow_domain_literals":"1","dns_again_means_nonexist":"1","bounce_message_file":"1","dns_trust_aa":"1","system_filter_group":"1","srs_hashmin":"1","lookup_open_max":"1","pipelining_advertise_hosts":"1","tls_eccurve":"1","smtp_load_reserve":"1","helo_allow_chars":"1","queue_only_override":"1","bounce_return_message":"1","localhost_number":"1","check_log_space":"1","strict_acl_vars":"1","helo_try_verify_hosts":"1","callout_positive_expire":"1","acl_smtp_connect":"1","queue_run_max":"1","daemon_startup_sleep":"1","errors_copy":"1","bounce_sender_authentication":"1","untrusted_set_sender":"1","dkim_verify_signers":"1","smtp_ratelimit_rcpt":"1","message_size_limit":"1","smtp_enforce_sync":"1","perl_at_start":"1","acl_smtp_notquit":"1","tls_advertise_hosts":"1","helo_verify_hosts":"1","acl_smtp_quit":"1","check_spool_inodes":"1","queue_smtp_domains":"1","message_body_newlines":"1","event_action":"1","openssl_options":"1","local_scan_timeout":"1","timezone":"1","tls_require_ciphers":"1","message_id_header_domain":"1","syslog_duplication":"1","primary_hostname":"1","dns_check_names_pattern":"1","remote_sort_domains":"1","exim_user":"1","local_from_prefix":"1","queue_list_requires_admin":"1","system_filter_file_transport":"1","message_body_visible":"1","headers_charset":"1","qualify_domain":"1","spf_guess":"1","dns_retrans":"1","acl_smtp_dkim":"1","gnutls_compat_mode":"1","disable_ipv6":"1","gnutls_require_protocols":"1","hosts_treat_as_local":"1","header_maxsize":"1","check_spool_space":"1","acl_smtp_mime":"1","callout_random_local_part":"1","uucp_from_sender":"1","host_lookup":"1","acl_smtp_data_prdr":"1","tls_verify_hosts":"1","log_file_path":"1","bounce_return_linesize_limit":"1","dns_use_edns0":"1","smtp_accept_reserve":"1","process_log_path":"1","dns_dnssec_ok":"1","dns_retry":"1","daemon_startup_retries":"1","host_reject_connection":"1","srs_secrets":"1","acl_smtp_starttls":"1","warn_message_file":"1","message_id_header_text":"1","dns_csa_search_limit":"1","local_from_suffix":"1","strip_trailing_dot":"1","delivery_date_remove":"1","return_path_remove":"1","timeout_frozen_after":"1","trusted_groups":"1","smtp_connect_backlog":"1","smtp_etrn_serialize":"1","gecos_pattern":"1","check_log_inodes":"1","acl_smtp_mail":"1","acl_smtp_vrfy":"1","qualify_recipient":"1","queue_domains":"1","host_lookup_order":"1","smtp_banner":"1","received_header_text":"1","header_line_maxsize":"1","allow_utf8_domains":"1","retry_interval_max":"1","bounce_return_body":"1","pid_file_path":"1","smtp_active_hostname":"1","smtp_accept_queue":"1","prod_requires_admin":"1","accept_8bitmime":"1","check_rfc2047_length":"1","receive_timeout":"1","tls_dhparam":"1","deliver_drop_privilege":"1","spool_directory":"1","recipient_unqualified_hosts":"1","smtp_check_spool_space":"1","tls_ocsp_file":"1","ignore_fromline_local":"1","keep_malformed":"1","acl_smtp_mailauth":"1","keep_environment":"1","perl_startup":"1","acl_smtp_data":"1","message_logs":"1","extract_addresses_remove_arguments":"1","local_interfaces":"1","add_environment":"1","queue_only_load_latch":"1","finduser_retries":"1","exim_path":"1","acl_not_smtp":"1","log_selector":"1","syslog_facility":"1","smtp_ratelimit_hosts":"1","acl_smtp_etrn":"1","rfc1413_query_timeout":"1","system_filter":"1","dns_ipv4_lookup":"1","smtp_etrn_command":"1","slow_lookup_log":"1","extra_local_interfaces":"1","syslog_processname":"1","hold_domains":"1","recipients_max":"1","dsn_from":"1","smtp_reserve_hosts":"1","allow_mx_to_ip":"1","max_username_length":"1","smtp_accept_max_per_connection":"1","bounce_message_text":"1","exim_group":"1","remote_max_parallel":"1","received_headers_max":"1","smtp_accept_max_per_host":"1","bi_command":"1","retry_data_expire":"1","auth_advertise_hosts":"1","delay_warning_condition":"1","print_topbitchars":"1","delay_warning":"1","dns_csa_use_reverse":"1","smtp_accept_max":"1","helo_lookup_domains":"1","queue_only_load":"1"},"force_command":"1","srs":"0","mailman":"1","spf":"1","dkim":"1","notquit":"1","content_scanning":"1","archive":"1","no_forward_outbound_spam_over_int":"0","rewrite_from_remote":"0","dovecot":"1","exiscan":"1"}},"result":"1"}},"error_msg":{"summary":"An invalid Exim configuration.","value":{"output":{"raw":"\n"},"reason":"OK","version":"1","command":"validate_exim_configuration_syntax","data":{"broken_cfg_text":"==>RAW_CONFIGURATION_TEXT<==\n","error_line":"1","error_msg":"This is an error message.","broken_cfg_html":"RAW_CONFIGURATION_TEXT"},"result":"1"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"in":"query","name":"cfg_text","required":"false","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.","schema":{"format":"HTML","example":"RAW_CONFIGURATION_TEXT","type":"string"}},{"in":"query","name":"section","required":"false","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.","schema":{"example":"acl","type":"string"}}],"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","x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_exim_configuration_syntax?api.version=1","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"tags":["Mail Server Settings"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"nvset":{"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/nvset":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  nvset \\\n  key='ThermalDetonator' \\\n  value='Active'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/nvset?api.version=1&key=ThermalDetonator&value=Active","label":"URL","lang":"HTTP"}],"x-cpanel-internal-only":"true","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"command":{"type":"string","example":"nvset","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"nvdatum":{"items":{"type":"object","properties":{"key":{"type":"string","description":"The variable's name.","example":"ThermalDetonator"},"value":{"example":"Active","description":"The variable's value.","type":"string"}}},"description":"A list of objects containing the variable's information.","type":"array"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"deprecated":"true","tags":["Styles"],"summary":"Update non-volatile variable value","x-cpanel-api-version":"WHM API 1","parameters":[{"name":"key","in":"query","required":"true","description":"The variable's name.","schema":{"example":"ThermalDetonator","type":"string"}},{"required":"true","name":"value","in":"query","schema":{"example":"Active","type":"string"},"description":"The variable's value."}],"description":"This function sets the value of a non-volatile variable. 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.\n\n**Note:**\n\n  We deprecated this function and recommend that you use the WHM API 1 `personalization_set` function.","operationId":"nvset","x-cpanel-available-version":"11"}}},"x-tagGroups":[{"name":"Accounts","tags":["Styles"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Styles","description":"The Server Administration module for WHM API 1."}]},"get_public_ip":{"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"description":"IP Address Management / Network Address Translation","name":"Network Address Translation"}],"paths":{"/get_public_ip":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_public_ip \\\n  ip='192.0.2.0'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_public_ip?api.version=1&ip=192.0.2.0","lang":"HTTP","label":"URL"}],"tags":["IP Addresses","Network Address Translation"],"summary":"Return public IP address of private IP address","x-cpanel-api-version":"WHM API 1","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":[{"schema":{"type":"string","format":"ipv4","example":"192.0.2.0"},"description":"A valid public or private IP address to query.","required":"true","in":"query","name":"ip"}],"x-cpanel-available-version":"62","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"get_public_ip","description":"The method name called.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}},"data":{"type":"object","properties":{"public_ip":{"format":"ipv4","description":"The public IP address.","example":"192.0.2.0","type":"string"}}}}}}}}}}}},"x-tagGroups":[{"name":"IP Address Management","tags":["Network Address Translation"]}]},"create_account_enhancement":{"x-tagGroups":[{"name":"Accounts","tags":["Account Enhancements"]}],"paths":{"/create_account_enhancement":{"get":{"parameters":[{"required":"true","name":"name","in":"query","schema":{"type":"string","maxLength":"80","example":"featurename 5000"},"description":"The name of the account enhancement."},{"required":"true","name":"id","in":"query","schema":{"type":"string","example":"sample-enhancement-id"},"description":"The identifier of the item you are targeting.\n\n**Note:**\n* You must use an [account enhancements ID](https://go.cpanel.net/add-account-enhancements) that a 3rd-party plugin defines.\n* To return a list of valid account enhancement IDs, run the WHM API 1 `list_account_enhancements` function."}],"description":"This function creates a new account enhancement.","operationId":"create_account_enhancement","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"example":"create_account_enhancement","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"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"}}},"data":{"type":"object","properties":{"name":{"description":"The name of the newly-created account enhancement.","example":"featurename 5000","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.98","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  create_account_enhancement \\\n  name='featurename 5000' \\\n  id='sample-enhancement-id'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/create_account_enhancement?api.version=1&name=featurename%205000&id=sample-enhancement-id","lang":"HTTP","label":"URL"}],"tags":["Account Enhancements"],"summary":"Create Account Enhancement","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"Account Enhancements","description":"The Account Enhancement module for WHM."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2"},"get_market_providers_list":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"tags":[{"description":"The Market module for WHM API 1.","name":"Market"},{"name":"Provider Management","description":"cPanel Market / Provider Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Provider Management"],"name":"cPanel Market"}],"paths":{"/get_market_providers_list":{"get":{"summary":"Return Market providers","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_market_providers_list\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_list?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Market","Provider Management"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects with information about each cPanel Market provider.","items":{"properties":{"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"},"enabled":{"type":"integer","description":"Whether the cPanel Market provider is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","example":"1","enum":["0","1"]},"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"},"display_name":{"type":"string","example":"cPanel Store","description":"The cPanel Market provider's display name."},"name":{"type":"string","description":"The cPanel Market provider's name.","example":"cPStore"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"get_market_providers_list","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"56","parameters":[],"description":"This function lists the available cPanel Market providers.","operationId":"get_market_providers_list"}}}},"cors_proxy_get":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/cors_proxy_get":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"content":{"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","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.","type":"string"},"_cp_redirects":{"items":{"properties":{"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"},"reason":{"type":"string","nullable":"true","description":"The response that the server returned.","example":"OK"},"url":{"type":"string","nullable":"true","format":"url","description":"The URL that provided the response.","example":"http://www.example.com"},"headers":{"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":{"vary":"Accept-Encoding","x-cache":"HIT","server":"ECS (dab/4BA8)","last-modified":"Thu, 17 Oct 2019 07:18:26 GMT","age":"425879","date":"Thu, 05 Mar 2020 23:42:25 GMT","content-type":"text/html; charset=UTF-8","expires":"Thu, 12 Mar 2020 23:42:25 GMT","cache-control":"max-age=604800","content-length":"1256","etag":"\"3147526947+ident\""},"nullable":"true","additionalProperties":{"x-additionalPropertiesName":"header-name","oneOf":[{"type":"string"},{"type":"integer"}]},"type":"object"},"protocol":{"nullable":"true","description":"The URL's HTTP protocol.","example":"HTTP/1.1","type":"string"},"status":{"type":"string","nullable":"true","example":"200","description":"The response's HTTP status code."}},"type":"object"},"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.","nullable":"true","type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","description":"The method name called.","example":"cors_proxy_get"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"68","x-cpanel-internal-only":"false","parameters":[{"description":"The website that you wish to access.","schema":{"example":"http://www.example.com","format":"url","type":"string"},"in":"query","name":"url","required":"true"}],"operationId":"cors_proxy_get","description":"This function allows your system to perform Cross-Origin Resource Sharing (CORS) HTTP requests.","x-cpanel-api-version":"WHM API 1","summary":"Enable CORS HTTP requests","tags":["API Execution"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cors_proxy_get \\\n  url='http://www.example.com'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/cors_proxy_get?api.version=1&url=http%3a%2f%2fwww.example.com"}]}}},"x-tagGroups":[{"tags":["API Execution"],"name":"API Development Tools"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"API Execution","description":"The Server Administration module for WHM API 1."}]},"changepackage":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/changepackage":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update user hosting plan","tags":["Packages","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  changepackage \\\n  user='username' \\\n  pkg='package1'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/changepackage?api.version=1&user=username&pkg=package1"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"example":"changepackage","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"output":{"properties":{"raw":{"type":"string","example":"<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>"}},"type":"object"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"schema":{"type":"string","example":"username","format":"username"},"description":"The cPanel account's username.","required":"true","name":"user","in":"query"},{"required":"true","in":"query","name":"pkg","schema":{"example":"package1","type":"string"},"description":"The hosting plan's name."}],"operationId":"changepackage","description":"This function changes a cPanel account's hosting plan (package)."}}},"x-tagGroups":[{"tags":["Account Management"],"name":"Accounts"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Accounts / Account Management","name":"Account Management"}]},"send_test_pushbullet_note":{"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Notifications","name":"Notifications"}],"paths":{"/send_test_pushbullet_note":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  send_test_pushbullet_note \\\n  access_token='a1b2c3d4e5f6g7h8i9j0'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/send_test_pushbullet_note?api.version=1&access_token=a1b2c3d4e5f6g7h8i9j0","lang":"HTTP","label":"URL"}],"tags":["Server Administration","Notifications"],"summary":"Send Pushbullet™ test with access token","x-cpanel-api-version":"WHM API 1","parameters":[{"description":"\nThe Pushbullet token to use.\n\n**Note:**\n\n* To access your Pushbullet token, navigate to [Pushbullet's My Account](https://www.pushbullet.com/account) page. It will appear under the *Access Token* heading.\n* This is confidential information that your server sends via a secure channel.","schema":{"type":"string","example":"a1b2c3d4e5f6g7h8i9j0"},"in":"query","name":"access_token","required":"true"}],"description":"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.\n\nIf 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.\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_pushbullet_note","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","example":"send_test_pushbullet_note","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"}}},"data":{"type":"object","properties":{"message_id":{"example":"554d2cbd-efe61da3cacb","description":"The test message's ID.","type":"string"},"payload":{"example":{"receiver_email":"user@example.com","active":"true","body":"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.","created":"1431976341.38872","receiver_iden":"ujw5ScArtjU","receiver_email_normalized":"user@example.com","dismissed":"false","sender_iden":"ujw5ScArtjU","title":"Test message (ID: 555a3994-173a4a271062d)","type":"note","direction":"self","sender_email":"user@example.com","sender_name":"Firstname Lastname","sender_email_normalized":"user@example.com","iden":"ujw5ScArtjUsjAeRXXMLGS","modifiedx":"1431976341.39182"},"description":"The payload from the Pushbullet server. For more information, visit [Pushbullet's API documentation](https://docs.pushbullet.com/).","additionalProperties":"true","type":"object"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52"}}},"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}]},"installable_mysql_versions":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"tags":["Manage MySQL Server"],"name":"Databases"}],"paths":{"/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":[],"x-cpanel-available-version":"cPanel 11.48","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"installable_mysql_versions","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"versions":{"type":"array","description":"An array of objects that contain information about the database version information.","items":{"type":"object","properties":{"version":{"type":"string","example":"10.0","description":"The version number in `major.minor` format."},"server":{"enum":["mysql","mariadb"],"example":"mariadb","description":"The server's database engine.\n* `mysql`\n* `mariadb`","type":"string"}}}}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  installable_mysql_versions\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/installable_mysql_versions?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Databases","Manage MySQL Server"],"summary":"Return available MySQL versions","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"description":"Databases / Manage MySQL Server","name":"Manage MySQL Server"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}]},"disable_authentication_provider":{"paths":{"/disable_authentication_provider":{"get":{"tags":["Authentication","External Authentication"],"x-codeSamples":[{"lang":"Shell","label":"CLI","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","summary":"Disable identity provider","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`","schema":{"type":"string","example":"cpaneld","enum":["cpaneld","webmaild","whostmgrd"]},"name":"service_name","in":"query","required":"true"},{"schema":{"example":"cpanelid","type":"string"},"description":"A valid identity provider's identification key.","required":"true","name":"provider_id","in":"query"}],"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"disable_authentication_provider"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"name":"Authentication","tags":["External Authentication"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"Authentication / External Authentication","name":"External Authentication"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"create_parked_domain_for_user":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"Domain Management","description":"DNS / Domain Management"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}],"paths":{"/create_parked_domain_for_user":{"get":{"x-cpanel-available-version":"82","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"create_parked_domain_for_user","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}},"type":"object"}}}}},"operationId":"create_parked_domain_for_user","description":"This function creates an alias (parks a domain on a web virtual host).","parameters":[{"schema":{"type":"string","example":"park.example.com","format":"domain"},"description":"The domain name to park.","required":"true","in":"query","name":"domain"},{"required":"true","in":"query","name":"username","schema":{"type":"string","example":"username"},"description":"The cPanel user account."},{"description":"An existing web virtual host to which the new domain name should be added.\n\n**Note:**\n\n If this is not the cPanel account’s main domain, then the system will consider the new domain to be an [addon domain](https://go.cpanel.net/cpaneldocsAddonDomains).","schema":{"type":"string","example":"vhost.example.com"},"name":"web_vhost_domain","in":"query","required":"true"}],"x-cpanel-api-version":"WHM API 1","summary":"Create domain alias","tags":["DNS","Domain Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  create_parked_domain_for_user \\\n  domain='park.example.com' \\\n  username='username' \\\n  web_vhost_domain='vhost.example.com'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/create_parked_domain_for_user?api.version=1&domain=park.example.com&username=username&web_vhost_domain=vhost.example.com"}]}}}},"rebuilduserssldb":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"name":"SSL Server Settings","description":"SSL Certificates / SSL Server Settings"}],"paths":{"/rebuilduserssldb":{"get":{"tags":["SSL","SSL Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  rebuilduserssldb\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/rebuilduserssldb?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update SSL certificate users database","operationId":"rebuilduserssldb","description":"This function rebuilds the database of SSL certificate users.","parameters":[],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"records":{"type":"array","description":"The cPanel accounts that the function rebuilt SSL certificate information for.","items":{"type":"string","format":"username","example":"username"}}}},"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"rebuilduserssldb","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["SSL Server Settings"],"name":"SSL Certificates"}]},"ticket_get_support_info":{"x-tagGroups":[{"tags":["Ticket Management"],"name":"cPanel Support Tickets"}],"paths":{"/ticket_get_support_info":{"get":{"x-cpanel-available-version":"78.0.6","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"tech_contact_email":{"type":"string","description":"The contact email address for the company's technical support.","format":"email","example":"support@example.com"},"distro":{"type":"string","description":"The server's operating system retrieved during the last license check.","example":"centos enterprise 6.8"},"ip":{"type":"string","format":"ipv4","description":"The license provider's IP address.","example":"192.168.0.1"},"logo_url":{"description":"The optional URL to the company's brand image file on the partner website.","format":"url","example":"http://example.com/assets/ourlogo.png","type":"string"},"has_compatibility_info":{"enum":["0","1"],"example":"1","description":"Whether the response contains the server's compatibility information.\n\n* `1` — Contains compatibility info.\n* `0` — Does **not** contain compatibility info.","type":"integer"},"hostname":{"example":"server.example.com","description":"The hostname or IP address of the server, as recorded in the license database.","type":"string"},"pub_tech_contact":{"type":"string","example":"https://support.example.com/","format":"url","description":"The optional URL to the company's technical support resources.\n\n**Note:**\n\nIf the `pub_tech_contact` return does not contain a value, the system\nwill use the `pub_support_contact` return's value."},"gets_direct_support":{"type":"integer","description":"Whether the IP address owner's primary support is WebPros International LLC.\n\n* `1` — Receives initial support from WebPros International, LLC.\n* `0` — Receives initial support from a partner.","enum":["0","1"],"example":"0"},"has_company_info":{"type":"integer","description":"Whether the response contains the company information associated with\nthe licensed IP address.\n\n* `1` — Contains company info.\n* `0` — Does **not** contain company info.","example":"0","enum":["0","1"]},"company_name":{"example":"Example, L.L.C.","description":"The company name associated with the submitted IP address.","type":"string"},"arch_supported":{"type":"integer","enum":["1","0","-1"],"example":"1","description":"Whether cPanel Support provides assistance with the server's CPU architecture.\n\n* `1` — Yes.\n* `0` — No.\n* `-1` — Unknown architecture."},"company_id":{"description":"A number that represents the company with the licensed IP address.","example":"7","type":"integer","minimum":"1"},"arch":{"example":"x86_64","description":"The server's CPU architecture retrieved at the last license check.","type":"string"},"pub_support_contact":{"type":"string","example":"http://documentation.example.com/","description":"The URL to the company's general support resources, if available.","format":"url"},"distro_supported":{"description":"Whether cPanel Technical Support provides assistance for the server's\noperating system.\n\n* `1` — Yes.\n* `0` — No.\n* `-1` — Unknown OS.","enum":["1","0","-1"],"example":"1","type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","example":"ticket_get_support_info","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"operationId":"ticket_get_support_info","description":"This function retrieves the license holder's support-related information.\n\n**Note:**\n\n* This function is **not** available through the command line. You **must** call\nit as a request body.\n* To use this function, you **must** set up a cPanelID token in your current session.\nFor more information, read our\n[cPanelID](https://docs.cpanel.net/knowledge-base/accounts/cpanelid/)\ndocumentation.","parameters":[],"x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"false","summary":"Import customer information from Customer Portal","tags":["Support Tickets","Ticket Management"],"x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_get_support_info?api.version=1"}]}}},"tags":[{"name":"Support Tickets","description":"The Support Tickets module for WHM API 1."},{"name":"Ticket Management","description":"cPanel Support Tickets / Ticket Management"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"dumpzone":{"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Zones","name":"DNS Zones"}],"paths":{"/dumpzone":{"get":{"tags":["DNS","DNS Zones"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  dumpzone \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/dumpzone?api.version=1&domain=example.com"}],"deprecated":"true","x-cpanel-api-version":"WHM API 1","summary":"Return domain's DNS zone configuration","parameters":[{"description":"The zone record's domain.","schema":{"type":"string","format":"domain","example":"example.com"},"in":"query","name":"domain","required":"true"},{"schema":{"type":"string","example":"example.com.db"},"description":"The zone file's name.","required":"false","name":"zone","in":"query"}],"operationId":"dumpzone","description":"This function returns a domain's DNS zone configuration.\n\n**Important:**\n\n* This function is **deprecated**. Use WHM's `parse_dns_zone` function.\n* You **must** include either the `domain` or the `zone` parameters.  \n* When you disable the [DNS role](https://go.cpanel.net/serverroles), the\nsystem **disables** this function.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of\nSPF resource records 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). CentOS 7\n  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\n  updated version of BIND that complies with RFC 7208. To resolve this issue,\n  update your operating system to a version that contains the updated version of\n  BIND. For more information, read the\n  [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"zone":{"type":"array","description":"An array of objects of zone information. This array contains the `record` array of objects.","items":{"anyOf":[{"$ref":"#/components/schemas/a"},{"$ref":"#/components/schemas/a6"},{"$ref":"#/components/schemas/aaaa"},{"$ref":"#/components/schemas/asfdb"},{"$ref":"#/components/schemas/caa"},{"$ref":"#/components/schemas/cname"},{"$ref":"#/components/schemas/dname"},{"$ref":"#/components/schemas/ds"},{"$ref":"#/components/schemas/hinfo"},{"$ref":"#/components/schemas/loc"},{"$ref":"#/components/schemas/mx"},{"$ref":"#/components/schemas/ns"},{"$ref":"#/components/schemas/ptr"},{"$ref":"#/components/schemas/rp"},{"$ref":"#/components/schemas/soa"},{"$ref":"#/components/schemas/srv"},{"$ref":"#/components/schemas/sshfp"},{"$ref":"#/components/schemas/txt"}]}}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"dumpzone","type":"string"},"reason":{"type":"string","example":"Zone Serialized","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{"asfdb":{"allOf":[{"properties":{"type":{"example":"AFSDB","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `AFSDB` — AFSDB records store the location of an AFS cell's database servers.","type":"string"},"hostname":{"description":"The database servers' hostname.","example":"afs.example.com","type":"string"},"subtype":{"type":"integer","description":"The AFS cell type. A 16-bit integer that represents the type of AFS cell. For example, a value of 1 indicates an AFS version 3.0 Volume Location Server.","example":"1"}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing AFSDB record data.\n\n**Note:**\n\nFor more information about AFSDB records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183)."},"loc":{"allOf":[{"properties":{"horiz_pre":{"description":"The location's horizontal precision, in meters.","example":"10","type":"integer","minimum":"0"},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `LOC` — LOC records store a hostname's geographical location.","example":"LOC"},"altitude":{"description":"The location's altitude. The location's altitude above sea level, in meters, and the m character.","example":"178m","type":"string"},"vert_pre":{"example":"10","description":"The location's vertical precision, in meters.","minimum":"0","type":"integer"},"version":{"description":"The record's version number. You **must** set this value to `0`.","example":"0","type":"integer"},"latitude":{"type":"string","description":"The location's latitude.","example":"41 51 54.305 N"},"size":{"minimum":"0","type":"integer","description":"The diameter of a sphere that encloses the entire location, in meters.","example":"10"},"longitude":{"description":"The location's longitude.","example":"87 36 47.95 W","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing LOC record data.\n\n**Note:**\n\nFor more information about LOC records, read [RFC 1876 at IANA](http://tools.ietf.org/html/rfc1876)."},"cname":{"allOf":[{"properties":{"cname":{"type":"string","example":"sydneybristow.example.com","description":"The canonical name (CNAME) alias."},"flatten_to":{"type":"string","example":"192.168.0.20","description":"The IP address to which the specified CNAME resolves."},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `CNAME` — CNAME records create an alias to another hostname.","example":"CNAME"},"flatten":{"description":"Whether the specified CNAME value resolves with the record's IP address.\n* `1` - Resolves.\n* `0` - Does **not** resolve.","example":"1","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing CNAME record data.\n\n**Note:**\n\nFor more information about CNAME records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035)."},"dname":{"allOf":[{"type":"object","properties":{"dname":{"example":"hostname.dev.example.com","description":"The delegation name (DNAME) alias.","type":"string"},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `DNAME` — DNAME records create an alias for a hostname and its subnames.","example":"DNAME"}}},{"$ref":"#/components/schemas/record"}],"description":"An object representing DNAME record data.\n\n**Note:**\n\nFor more information about DNAME records, read [RFC 2672 at IANA](http://tools.ietf.org/html/rfc2672)."},"aaaa":{"description":"An object representing AAAA record data.\n\n**Note:**\n\nFor more information about AAAA records, read [RFC 3596 at IANA](http://tools.ietf.org/html/rfc3596).","allOf":[{"properties":{"address":{"type":"string","description":"The zone record's IPv6 address.","example":"2001:1:42:1::2a"},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `AAAA` — AAAA records store IPv6 addresses.\n\n**Important:**\n\nA6 records are **deprecated**. We strongly **recommend** that you use [AAAA](http://tools.ietf.org/html/rfc3596) records to store IPv6 addresses.","example":"AAAA"}},"type":"object"},{"$ref":"#/components/schemas/record"}]},"ns":{"description":"An object representing NS record data.\n\n**Note:**\n\nFor more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","allOf":[{"type":"object","properties":{"type":{"type":"string","example":"NS","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `NS` — NS records store a domain's authoritative nameservers."},"nsdname":{"type":"string","example":"ns1.example.com","description":"The domain's authoritative nameserver."}}},{"$ref":"#/components/schemas/record"}]},"ptr":{"description":"An object representing PTR record data.\n\n**Note:**\n\nFor more information about PTR records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","allOf":[{"properties":{"ptrdname":{"example":"hostname.example.com.","description":"A pointer to a canonical name (CNAME).","type":"string"},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `PTR` — PTR records point to a CNAME.","example":"PTR"}},"type":"object"},{"$ref":"#/components/schemas/record"}]},"sshfp":{"description":"An object representing SSHFP record data.\n\n**Warning:**\n\nWe do **not** currently support this DNS record type.\n\n**Note:**\n\nFor more information about SSHFP records, read [RFC 4255 at IANA](http://tools.ietf.org/html/rfc4255).","allOf":[{"properties":{"type":{"type":"string","example":"SSHFP","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `SSHFP` — SSHFP records store a domain's SSH public host key's fingerprint.\n\n**Warning:**\n\n  We do **not** currently support the SSHFP DNS record type."},"algorithm":{"description":"The public key's algorithm number.\n* `1` — RSA\n* `2` — DSS","example":"1","type":"integer"},"fptype":{"type":"integer","example":"1","description":"The public key's fingerprint type.\n* `1` — SHA-1"}},"type":"object"},{"$ref":"#/components/schemas/record"}]},"txt":{"allOf":[{"properties":{"type":{"description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `TXT` — TXT records store descriptive text or useful records (for example, SPF or DKIM records).","example":"TXT","type":"string"},"unencoded":{"type":"integer","example":"1","description":"Whether the TXT record's data is encoded.\n* `1` — Encoded.\n* `0` — **Not** encoded."},"txtdata":{"example":"v=spf1 a -all","description":"The TXT record's data.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing TXT record data.\n\n**Note:**\n\nFor more information about TXT records, read [RFC 1464 at IANA](http://tools.ietf.org/html/rfc1464)."},"rp":{"description":"An object representing RP record data.\n\n**Note:**\n\nFor more information about RP records, read [RFC 1183 at IANA](https://tools.ietf.org/html/rfc1183).","allOf":[{"properties":{"mbox":{"type":"string","description":"The Responsible Person's (RP's) email address.","example":"user.example.com."},"type":{"example":"RP","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `RP` — RP records store a domain's Responsible Person's information.","type":"string"},"txtdname":{"type":"string","example":"mx1.host.example.com.","description":"The RP's domain name."}},"type":"object"},{"$ref":"#/components/schemas/record"}]},"a":{"description":"An object representing A record data.\n\n**Note:**\n\nFor more information about A records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","allOf":[{"type":"object","properties":{"type":{"example":"A","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `A` — A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.","type":"string"},"address":{"example":"192.168.0.20","description":"The zone record's IPv4 address.","type":"string"}}},{"$ref":"#/components/schemas/record"}]},"a6":{"description":"An object representing A6 record data.\n\n**Important:**\n\nA6 records are **deprecated**. We strongly **recommend** that you use [AAAA](http://tools.ietf.org/html/rfc3596) records to store IPv6 addresses.","allOf":[{"type":"object","properties":{"prefix":{"description":"The record's prefix length.","example":"48","type":"integer"},"refer":{"description":"The record's address suffix.","example":"0::0","type":"string"},"type":{"type":"string","example":"A6","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `A6` — A6 records store IPv6 addresses.\n\n**Important:**\n\nA6 records are **deprecated**. We strongly **recommend** that you use [AAAA](http://tools.ietf.org/html/rfc3596) records to store IPv6 addresses."}}},{"$ref":"#/components/schemas/record"}]},"ds":{"allOf":[{"properties":{"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `DS` — DS records specify a record's delegation signer.","example":"DS"},"digtype":{"description":"The record's digest type.\n* `1` — SHA-1\n* `2` — SHA-256\n* `4` — SHA-384","example":"1","type":"integer"},"keyname":{"type":"integer","description":"The record's KeyTag value.","example":"2642"},"algorithm":{"type":"integer","description":"The record's algorithm number.\n* `1` — RSAMD5\n* `2` — Diffie-Hellman\n* `3` — DSA/SHA-1\n* `4` — Elliptic Curve\n* `5` — RSA/SHA-1\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* `252` — Indirect\n* `253` — Private DNS\n* `254` — Private OID","example":"5"}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing DS record data.\n\n**Note:**\n\nFor more information about DS records, read [RFC 4034 at IANA](http://tools.ietf.org/html/rfc4034)."},"srv":{"description":"An object representing SRV record data.\n\n**Note:**\n\nFor more information about SRV records, read [RFC 2782 at IANA](http://tools.ietf.org/html/rfc2782).","allOf":[{"type":"object","properties":{"port":{"type":"integer","example":"389","description":"The target host's port."},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `SRV` — SRV records store the service location records for newer protocols (for example, Autodiscover).","example":"SRV"},"target":{"type":"string","example":"service.example.com","format":"domain","description":"The service's target host."},"weight":{"type":"integer","description":"A relative weight. The system uses this value to rank entries with the same `priority` value. An integer that represents the target host's weight against other hosts with the same `priority` value.","example":"2"},"priority":{"description":"The target host's preference. An integer that represents the target host's priority order.\n\n**Note:**\n\nLower numbers have a higher priority order.","example":"0","type":"integer"}}},{"$ref":"#/components/schemas/record"}]},"soa":{"allOf":[{"type":"object","properties":{"mname":{"type":"string","description":"The domain's authoritative nameserver.","example":"ns1.example.com"},"refresh":{"minimum":"0","type":"integer","description":"The amount of time to wait before the secondary DNS server queries the primary DNS server's SOA records for changes, in seconds.","example":"1440"},"type":{"type":"string","example":"SOA","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `SOA` — SOA records designate the beginning of a zone of authority."},"Lines":{"minimum":"0","type":"integer","example":"4","description":"The number of lines in the SOA section."},"retry":{"type":"integer","minimum":"0","description":"The amount of time to wait before the secondary server retries a failed zone transfer, in seconds.","example":"1440"},"rname":{"example":"user.example.com.","description":"The Responsible Person's (RP's) email address.","type":"string"},"serial":{"example":"2013122501","description":"The zone file's revision number.","type":"integer"},"expire":{"minimum":"0","type":"integer","description":"The amount of time to wait before the secondary server attempts to complete a zone transfer, in seconds.","example":"3600000"}}},{"$ref":"#/components/schemas/record"}],"description":"An object representing SOA record data.\n\n**Note:**\n\nFor more information about SOA records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035)."},"hinfo":{"description":"An object representing HINFO record data.\n\n**Note:**\n\nFor more information about HINFO records, read [RFC 1700 at IANA](http://tools.ietf.org/html/rfc1700.txt).","allOf":[{"type":"object","properties":{"type":{"description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `HINFO` — HINFO records specify a host's CPU and OS types.","example":"HINFO","type":"string"},"cpu":{"example":"INTEL-386","description":"The host's CPU type.","type":"string"},"os":{"example":"UNIX","description":"The host's operating system.","type":"string"}}},{"$ref":"#/components/schemas/record"}]},"record":{"type":"object","properties":{"name":{"example":"hostname.example.com","description":"The record's name.","type":"string"},"ttl":{"type":"integer","description":"The record's Time To Live (TTL).","example":"86400"},"class":{"example":"IN","description":"The record's class.\n- IN\n- Very rarely, another valid DNS record class.","type":"string"},"Line":{"description":"The zone record's line number.","example":"1","type":"integer"}}},"mx":{"allOf":[{"properties":{"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `MX` — MX records point a domain name to its MTAs.","example":"MX"},"preference":{"type":"integer","description":"The record's preference. An integer that represents the record's priority order.\n\n**Note:**\n\nLower values have a higher priority order.","example":"10"},"exchange":{"example":"mail.example.com","description":"The server's location's canonical name (CNAME).","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing MX record data.\n\n**Note:**\n\nFor more information about MX records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035)."},"caa":{"allOf":[{"properties":{"tag":{"type":"string","description":"The CAA record's property type.\n* `issue` - A CA issued a certificate for the domain.\n* `issuewild` - A CA issued a wildcard certificate for the domain.\n* `iodef` - The user specified a URL to which a CA may report policy violations.","example":"issue"},"value":{"type":"string","description":"The CA's domain or URL.\n* A valid [SSL provider](https://sslmate.com/labs/caa/).\n* A mailto URL or a standard URL.","example":"totallyrealca.tld"},"type":{"example":"CAA","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n* `CAA` — CAA records control which certificate authorities can issue SSL certificates for a domain.","type":"string"},"flag":{"type":"integer","example":"0","description":"Whether the CA will issue an SSL certificate if the CAA resource record contains unknown property tags.\n* `0` - Non-critical. The CAA Resource Record contains unknown property tags, and the CA issued an SSL certificate.\n* `1` - Critical. The CAA Resource Record contains unknown property tags, and the CA did **not** issue an SSL certificate."}},"type":"object"},{"$ref":"#/components/schemas/record"}],"description":"An object representing CAA record data.\n\n**Note:**\n\nFor more information about CAA record flags and property tags, read the [RFC 6844](https://tools.ietf.org/html/rfc6844#section-3) documentation."}}}},"get_users_features_settings":{"paths":{"/get_users_features_settings":{"get":{"tags":["Packages","Feature Access"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_users_features_settings \\\n  user='example'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_features_settings?api.version=1&user=example","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel accounts' feature settings","operationId":"get_users_features_settings","description":"This function lists the features settings of cPanel accounts.","parameters":[{"in":"query","name":"user","required":"true","examples":{"multiple":{"value":"user-1=example1 user-2=example2 user-3=example3","description":"Multiple users."},"single":{"value":"example","description":"A single user."}},"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`.","schema":{"type":"string"}},{"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":{"single":{"value":"autossl","description":"A single feature."},"multiple":{"value":"feature-1=autossl feature-2=addoncgi feature-3=addondomains","description":"Multiple feature."}},"required":"false","name":"feature","in":"query"}],"x-cpanel-available-version":"58","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":{"user":{"type":"string","example":"example","format":"username","description":"The user's username."},"feature_list":{"type":"string","example":"autossl","description":"The feature list's name."},"feature_list_setting":{"type":"integer","enum":["1","0"],"example":"1","description":"The user's feature list setting.\n* `1` - Enabled.\n* `0` - Disabled."},"feature":{"example":"autossl","description":"The feature name.","type":"string"},"cpuser_setting":{"example":"1","enum":["1","0"],"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.","nullable":"true","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"get_users_features_settings"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Feature Access"],"name":"Hosting Plans"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"name":"Feature Access","description":"Hosting Plans / Feature Access"}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"nginxmanager_get_cache_config_system":{"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/nginxmanager_get_cache_config_system":{"get":{"tags":["NGINX Manager"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  nginxmanager_get_cache_config_system\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_get_cache_config_system?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return NGINX caching configurations.","parameters":[{"schema":{"type":"integer","example":"1","enum":["1"]},"description":"Whether to combine the default and system NGINX configurations when returning configuration data.\n\n**Note:**\n\n* `1` - Return the configuration with default and system values combined.","required":"false","name":"merge","in":"query"}],"description":"This function returns the system NGINX cache configuration.","operationId":"nginxmanager_get_cache_config_system","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"system":{"description":"The system's configuration values.","properties":{"enabled":{"description":"Caching is enabled or disabled.\n\n**Note:**\n\n* `true` - Caching is enabled\n* `false` - Caching is disabled\nenum:\n- true\n- false\ntype: boolean"}},"additionalProperties":{"description":"The system's configuration values.\n\n**Note:**\n\nThe key names are the configuration properties. For more information, read the NGINX Caching documentation.\n\n[Nginx with Reverse Proxy | cPanel & WHM Documentation](https://go.cpanel.net/nginx-cache-settings)"}},"default":{"description":"The default configuration values.","properties":{"enabled":{"description":"Caching is enabled or disabled.\n\n**Note:**\n\n* `1` - Caching is enabled\n* `0` - Caching is disabled","enum":["0","1"],"type":"integer"}},"additionalProperties":{"description":"The default configuration values.\n\n**Note:**\n\nThe key names are the configuration properties. For more information, read the NGINX Caching documentation.\n\n[Nginx with Reverse Proxy | cPanel & WHM Documentation](https://go.cpanel.net/nginx-cache-settings)"}}},"example":{"system":{"levels":"1:2","zone_size":"10m","proxy_cache_background_update":"on","proxy_cache_use_stale":"error timeout http_429 http_500 http_502 http_503 http_504","logging":"false","x_cache_header":"0","proxy_cache_min_uses":"1","proxy_cache_lock":"on","inactive_time":"60m","enabled":"true","proxy_cache_revalidate":"on"},"default":{"proxy_cache_lock":"on","proxy_cache_revalidate":"on","enabled":"1","inactive_time":"60m","levels":"1:2","x_cache_header":"0","proxy_cache_min_uses":"1","proxy_cache_use_stale":"error timeout http_429 http_500 http_502 http_503 http_504","logging":"0","proxy_cache_background_update":"on","zone_size":"10m"}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"nginxmanager_set_config","description":"The method name called.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"tags":["NGINX Manager"],"name":"NGINX Manager"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"NGINX Manager","description":"The NGINX Manager module for WHM API 1."}]},"verify_slack_access":{"openapi":"3.0.2","info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.91.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Notifications","name":"Notifications"}],"paths":{"/verify_slack_access":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Verify Slack® Webhook connection","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  verify_slack_access\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_slack_access?api.version=1"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"verify_slack_access","description":"The method name called."},"result":{"type":"integer","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"}}},"data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"result":{"type":"object","properties":{"payload":{"type":"object","properties":{"success":{},"url":{},"reason":{},"content":{},"headers":{"properties":{"server":{},"strict-transport-security":{},"x-frame-options":{},"vary":{},"x-via":{},"access-control-allow-origin":{},"transfer-encoding":{},"date":{},"referrer-policy":{},"content-type":{},"x-slack-backend":{}},"type":"object"},"protocol":{},"status":{}}},"message_id":{}}},"url":{}}},"description":"The payload from the Slack server. For more information, visit Slack's WebHooks documentation ."}}}},"type":"object"}}}}},"x-cpanel-available-version":"90","parameters":[],"description":"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 ).","operationId":"verify_slack_access"}}},"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}]},"fetch_dkim_private_keys":{"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"paths":{"/fetch_dkim_private_keys":{"get":{"parameters":[{"required":"true","in":"query","name":"domain","schema":{"type":"string"},"examples":{"single":{"value":"example.com","summary":"Query a single domain."},"multiple":{"summary":"Query multiple domains.","value":"domain=example-1.com&domain=example-2.com&domain=example-3.com"}},"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."}],"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","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"payload":{"type":"array","items":{"properties":{"domain":{"type":"string","description":"The queried domain.","example":"example.com"},"pem":{"type":"string","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":"object"},"description":"An array containing information about the domain's DKIM private key."}}},"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"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"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"78","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  fetch_dkim_private_keys \\\n  domain='example.com'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_dkim_private_keys?api.version=1&domain=example.com"}],"tags":["Mail","Mail DNS Settings"],"summary":"Return domain's DKIM private key","x-cpanel-api-version":"WHM API 1"}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."}},"importsshkey":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"SSH Keys and Connections","description":"Authentication / SSH Keys and Connections"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Authentication","tags":["SSH Keys and Connections"]}],"paths":{"/importsshkey":{"get":{"tags":["SSH Keys and Connections"],"x-codeSamples":[{"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","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","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","summary":"Import SSH key","description":"This function imports an SSH key.","operationId":"importsshkey","parameters":[{"required":"true","in":"query","name":"name","schema":{"type":"string","example":"TestKey"},"description":"The key's name."},{"description":"The key's contents.","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"},"name":"key","in":"query","required":"true"},{"schema":{"type":"integer","enum":["0","1"],"example":"0"},"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.","required":"false","name":"extract_public","in":"query"},{"required":"false","name":"extract_private","in":"query","schema":{"example":"0","enum":["0","1"],"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."},{"schema":{"example":"123456luggage","default":null,"nullable":"true","type":"string"},"description":"The key's passphrase.\n\n**Note:**\n\nThis parameter is **required** whenever you import a PPK file.","required":"false","in":"query","name":"passphrase"}],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","description":"The method name called.","example":"importsshkey"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}}},"save_cphulk_config":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Settings"]}],"paths":{"/save_cphulk_config":{"get":{"tags":["cPHulk","Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  save_cphulk_config\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/save_cphulk_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Save login security configuration settings","parameters":[{"schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"description":"Whether to use the server firewall to block brute force attacks.\n* `1` — Use the firewall.\n* `0` — Do **not** use the firewall.","required":"false","name":"block_brute_force_with_firewall","in":"query"},{"schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"},"description":"Whether to use the server firewall to block excessive brute force attacks.\n* `1` — Use the firewall.\n* `0` — Do **not** use the firewall.","required":"false","name":"block_excessive_brute_force_with_firewall","in":"query"},{"name":"brute_force_period_mins","in":"query","required":"false","description":"The number of minutes over which cPHulk measures all login attempts to a specific user's account.","schema":{"type":"integer","minimum":"1","default":"5","example":"5"}},{"required":"false","in":"query","name":"command_to_run_on_brute_force","schema":{"type":"string","example":"","default":""},"description":"The command to run when an IP address triggers brute force protection.\n\n**Note:**\n\n For a list of commands, read the *Command variables* section of our [cPHulk Brute Force Protection](https://go.cpanel.net/whmdocscPHulkBruteForceProtection) documentation."},{"description":"The command to run when the system blocks an IP address for a one day period.\n\n**Note:**\n\n For a list of commands, read the *Command variables* section of our [cPHulk Brute Force Protection](https://go.cpanel.net/whmdocscPHulkBruteForceProtection) documentation.","schema":{"type":"string","default":"","example":""},"in":"query","name":"command_to_run_on_excessive_brute_force","required":"false"},{"schema":{"default":"1","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to enable IP address-based protection on all requests.\n* `1` — Enable IP-based protection.\n* `0` — Disable IP-based protection.\n\n**Note:**\n\n If you set this parameter to `0`, you **cannot** use the following parameters:\n * `block_brute_force_with_firewall`\n * `block_excessive_brute_force_with_firewall`\n * `ip_brute_force_period_mins`","required":"false","name":"ip_based_protection","in":"query"},{"in":"query","name":"ip_brute_force_period_mins","required":"false","description":"The number of minutes in which cPHulk measures an attacker's login attempts.","schema":{"default":"15","example":"15","type":"integer","minimum":"1"}},{"schema":{"default":"360","example":"360","minimum":"0","type":"integer"},"description":"The number of minutes over which cPHulk counts failed logins against a user.","required":"false","name":"lookback_period_min","in":"query"},{"name":"mark_as_brute","in":"query","required":"false","description":"The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.","schema":{"type":"integer","minimum":"0","default":"30","example":"30"}},{"description":"The maximum number of failures that cPHulk allows per account within the defined time range.","schema":{"type":"integer","minimum":"0","default":"30","example":"30"},"name":"max_failures","in":"query","required":"false"},{"name":"max_failures_byip","in":"query","required":"false","description":"The maximum number of failures from a specific IP address before cPHulk locks out that address.","schema":{"default":"5","example":"5","type":"integer","minimum":"0"}},{"schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"description":"Whether cPHulk will send a notification when it detects a brute force attack.\n* `1` — Send the notification.\n* `0` — Do **not** send the notification.","required":"false","in":"query","name":"notify_on_brute"},{"schema":{"example":"0","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether cPHulk will send a notification when the `root` user successfully logs in from an IP address that is not on the whitelist.\n* `1` — Send the notification.\n* `0` — Do **not** send the notification.","required":"false","in":"query","name":"notify_on_root_login"},{"required":"false","name":"notify_on_root_login_for_known_netblock","in":"query","schema":{"type":"integer","example":"0","enum":["0","1"],"default":"0"},"description":"Whether cPHulk sends a notification upon successful `root` login when the IP address is not on the whitelist, but from a known netblock.\n* `1` — Send the notification.\n* `0` — Do **not** send the notification."},{"description":"Whether to skip checking if cPHulk runs on the server.\n* `1` — Don't check cPHulk's status.\n* `0` — Check cPHulk's status.\n\n**Note:**\n\nIf cPHulk is disabled, the function returns the following message:\n`cPHulk is disabled on the server.`","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"name":"skip_enabled_check","in":"query","required":"false"},{"schema":{"example":"0","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to enable username-based protection on all requests.\n* `1` — Enable.\n* `0` — Disable.","required":"false","in":"query","name":"username_based_protection"},{"schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"},"description":"Whether to allow username-based protection to lock out the `root` user.\n* `1` — Allow.\n* `0` — Do **not** allow.","required":"false","in":"query","name":"username_based_protection_for_root"},{"schema":{"default":"1","example":"1","enum":["0","1"],"type":"integer"},"description":"Whether to enable username-based protection **only** on requests that originate from a local IP address.\n* `1` — Enable.\n* `0` — Disable.","required":"false","in":"query","name":"username_based_protection_local_origin"}],"operationId":"save_cphulk_config","description":"This function modifies cPHulk's configuration settings.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"save_cphulk_config","description":"The method name called."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"restart_ssh":{"example":"1","enum":["0","1"],"description":"Whether the system disabled UseDNS in the `sshd.conf` file and restarted the `sshd` daemon to allow cPHulk to add IP addresses to the whitelist.\n\n**Note:**\n\n This return **only** appears if the `UseDNS` setting is `yes` in the `/etc/ssh/sshd_config` file. Because UseDNS and cPHulk are incompatible, the system sets the `UseDNS` setting to `no` when you enable cPHulk.\n* `1` - Disabled UseDNS in the `sshd` daemon and restarted the `sshd` service.\n* `0` - Did **not** alter the `sshd.conf` file or restart the `sshd` service.","type":"integer"},"warning":{"nullable":"true","example":null,"description":"A warning message about the restart.\n\n**Note:**\n\nThe function **only** returns this value if the `restart_ssh` return's value is `1`.","type":"string"},"cphulk_config":{"properties":{"command_to_run_on_excessive_brute_force":{"example":"","description":"The command to run when the system blocks an IP address blocked for a one day period.","type":"string"},"ip_brute_force_period_sec":{"type":"integer","example":"900","description":"The number of seconds in which cPHulk measures an attacker's login attempts."},"max_failures":{"type":"integer","minimum":"0","example":"30","description":"The maximum number of failures that cPHulk allows per account within the defined time range."},"brute_force_period_mins":{"minimum":"1","type":"integer","description":"The number of minutes over which cPHulk measures all login attempts to a specific user's account.","example":"5"},"max_failures_byip":{"minimum":"0","type":"integer","description":"The maximum number of failures from a specific IP address before cPHulk locks out that address.","example":"5"},"ip_brute_force_period_mins":{"type":"integer","minimum":"1","example":"15","description":"The number of minutes in which cPHulk measures an attacker's login attempts."},"lookback_time":{"example":"21600","description":"The number of seconds over which cPHulk counts failed logins against a user.","type":"integer"},"username_based_protection":{"description":"Whether username-based protection on all requests is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":["0","1"],"example":"0","type":"integer"},"ip_based_protection":{"description":"Whether IP address-based protection on all requests is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":["0","1"],"example":"1","type":"integer"},"notify_on_root_login_for_known_netblock":{"example":"0","enum":["0","1"],"description":"Whether cPHulk sends a notification upon successful `root` login when the IP address is not on the whitelist, but from a known netblock.\n* `1` - Send the notification.\n* `0` - Do **not** send the notification.","type":"integer"},"lookback_period_min":{"type":"integer","minimum":"0","description":"The number of minutes over which cPHulk counts failed logins against a user.","example":"360"},"block_excessive_brute_force_with_firewall":{"description":"Whether to use cPanel & WHM's firewall to block excessive brute force attacks.\n* `1` - Use the firewall.\n* `0` - Do **not** use the firewall.","enum":["0","1"],"example":"0","type":"integer"},"username_based_protection_local_origin":{"type":"integer","description":"Whether username-based protection **only** on requests that originate from a local IP address.\n* `1` - Enabled.\n* `0` - Disabled.","example":"1","enum":["0","1"]},"can_temp_ban_firewall":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the system firewall can apply temporary IP address bans.\n* `1` - Can temporarily apply IP address bans.\n* `0` - **Cannot** temporarily apply IP address bans.\n\n**Note:**\n\nIf this return's value is `0`, then the `ip_based_protection` parameter is **not** available, which means that you cannot use the following parameters:\n* `block_brute_force_with_firewall`\n* `block_excessive_brute_force_with_firewall`\n* `ip_brute_force_period_mins`\n* `ip_brute_force_period_sec`"},"command_to_run_on_brute_force":{"example":"","description":"The command to run when an IP address triggers brute force protection.","type":"string"},"notify_on_brute":{"type":"integer","description":"Whether cPHulk will send a notification when it detects a brute force attack.\n* `1` - Send the notification.\n* `0` - Do **not** send the notification.","example":"0","enum":["0","1"]},"is_enabled":{"description":"Whether the cPHulk service is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","example":"1","enum":["0","1"],"type":"integer"},"brute_force_period_sec":{"type":"integer","example":"300","description":"The number of seconds over which cPHulk measures all login attempts to a specific user's account."},"notify_on_root_login":{"description":"Whether cPHulk will send a notification when the `root` user successfully logs in from an IP address that is not on the whitelist.\n* `1` - Send the notification.\n* `0` - Do **not** send the notification.","example":"0","enum":["0","1"],"type":"integer"},"mark_as_brute":{"example":"30","description":"The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.","type":"integer","minimum":"0"},"username_based_protection_for_root":{"type":"integer","description":"Whether username-based protection can lock out the `root` user.\n* `1` - Allowed.\n* `0` - **Not** allowed.","enum":["0","1"],"example":"0"},"block_brute_force_with_firewall":{"description":"Whether to use cPanel & WHM's firewall to block brute force attacks.\n* `1` -  Use the firewall.\n* `0` - Do **not** use the firewall.","enum":["0","1"],"example":"0","type":"integer"}},"type":"object","description":"An object containing cPHulk configuration settings."}},"type":"object"}}}}}}},"x-cpanel-available-version":"11.48"}}},"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"description":"Login Security (cPHulk) / Settings","name":"Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}]},"flush_cphulk_login_history":{"paths":{"/flush_cphulk_login_history":{"get":{"summary":"Remove all login security records","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  flush_cphulk_login_history\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/flush_cphulk_login_history?api.version=1","lang":"HTTP","label":"URL"}],"tags":["cPHulk","Management"],"x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","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.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"flush_cphulk_login_history"}}},"data":{"type":"object","properties":{"records_removed":{"description":"The number of entries that the function deleted\nfrom the cPHulk database.","example":"10","minimum":"0","type":"integer"}}}},"type":"object"}}}}},"operationId":"flush_cphulk_login_history","description":"This function removes the login history entries from the cPHulk\ndatabase.","parameters":[]}}},"x-tagGroups":[{"tags":["Management"],"name":"Login Security (cPHulk)"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"description":"Login Security (cPHulk) / Management","name":"Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"list_hooks":{"tags":[{"description":"The Script Hooks module for WHM API 1.","name":"Script Hooks"},{"description":"Integrations / Scripts Hooks","name":"Scripts Hooks"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Scripts Hooks"],"name":"Integrations"}],"paths":{"/list_hooks":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return script hooks list","tags":["Script Hooks","Scripts Hooks"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_hooks\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_hooks?api.version=1","label":"URL","lang":"HTTP"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":["1","0"],"example":"1","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"list_hooks","type":"string"}}},"data":{"properties":{"categories":{"items":{"type":"object","properties":{"category":{"type":"string","description":"The script hook's category.","example":"RPM::Versions"},"events":{"items":{"properties":{"stages":{"type":"array","description":"An array of objects containing stage information.","items":{"type":"object","properties":{"actions":{"type":"array","description":"An array of objects containing information about hook script actions.","items":{"properties":{"blocking":{"type":"integer","description":"Whether the script hook has a blocking contest.\n\n* `1` — Blocking contest.\n* `0` — No blocking contest.","example":"0","enum":["1","0"]},"check":{"nullable":"true","example":null,"description":"The absolute file path to the script that runs after the hook script to check the results.","type":"string"},"description":{"type":"string","description":"The hook script's description.","example":"A script description.","nullable":"true"},"rollback":{"type":"string","example":null,"description":"The absolute file path to the script that can roll back the hook script.","nullable":"true"},"category":{"example":"RPM::Versions","description":"The script hook's category.","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"},"hook":{"description":"The absolute file path to the hook script.","example":"/scripts/postcourier-authlibup","type":"string"},"id":{"example":"KQVO65K_8MWe__3JMPETn43S","description":"The script hook's ID.","type":"string"},"enabled":{"description":"Whether the hook script is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"1","type":"integer"},"weight":{"type":"integer","minimum":"1","example":"100","description":"The priority of the script hook, where lower values run before higher values."},"event":{"type":"string","description":"The event that triggers the script hook.","example":"MariaDB-server"},"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"},"exectype":{"description":"The type of function that the script hook launches.\n\n* `script` — A script function.\n* `module` — A Perl module function.","example":"script","enum":["script","module"],"type":"string"}},"type":"object"}},"attributes":{"description":"A list of hook script attributes.","type":"object","properties":{"blocking":{"type":"integer","description":"Whether the script hook contains a blocking context.\n\n* `1` — Blocking context.\n* `0` — No blocking context.","enum":["1","0"],"example":"0"},"escalateprivs":{"type":"integer","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"}}},"stage":{"example":"post","description":"When the hook script will execute.\n\n* `pre` — The script runs before the function.\n* `post` — The script runs after the function.","type":"string"},"description":{"type":"string","example":"My hook script.","description":"The hook script's description."}}}},"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.","items":{"type":"string"},"example":["pre","post"],"type":"array"},"event":{"description":"The event that triggers the script hook.","example":"MariaDB-server","type":"string"}},"type":"object"},"description":"An array of objects containing events.","type":"array"}}},"description":"An array of objects containing hook categories.","type":"array"}},"type":"object"}}}}}}},"x-cpanel-available-version":"11.32","parameters":[],"operationId":"list_hooks","description":"This function lists the server's script hooks."}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"restrict_whm_root_access":{"x-tagGroups":[{"tags":["WHM Access"],"name":"Security"}],"paths":{"/restrict_whm_root_access":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Restrict Access to WHM by CIDR list.","tags":["WHM Access"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  restrict_whm_root_access \\\n  cidr=10.2.0.0/16 \\\n  cidr=10.6.5.0/24 \\\n  cidr=10.1.6.7\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restrict_whm_root_access?api.version=1&cidr=10.2.0.0/16&cidr=10.6.5.0/24&cidr=10.1.6.7","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"108","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"cidr":{"type":"array","description":"A reduced list of what CIDR addresses root access will be restricted to.","items":{"type":"string","format":"cidr"},"example":["10.2.0.0/16","10.6.5.0/24","10.1.6.7"]}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"example":"restrict_whm_root_access","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details."}}}}}}},"description":"HTTP Request was successful."}},"operationId":"restrict_whm_root_access","description":"This function restricts root login to cPanel & WHM based on a list of CIDR addresses.\n\n**Note:**\n\nThis API manipulates `/var/cpanel/authorized_whm_root_ips`. We HIGHLY recommend\nyou not modify this file directly. Improper formatting of the file can lead to loss of all\naccess to cPanel & WHM using the root password.\n\nUse of this API replaces any previous restrictions so be sure to include previous CIDR patterns\nwhen adding new ones.\n\nAs this API only restricts logins, please be aware that existing root logins are not terminated\nwhen these restrictions are asserted.\n\nThis API DOES NOT restrict root resellers.","parameters":[{"description":"The IPs you wish to restrict in CIDR format.\n\n**Note:**\n\nYou can pass this parameter multiple times.","style":"form","in":"query","name":"cidr","required":"true","examples":{"single":{"summary":"A single CIDR Address","value":"10.2.0.0/16"},"multiple":{"value":["10.2.0.0/16","10.6.5.0/24","10.1.6.7"],"summary":"Multiple CIDR Addresses."}},"schema":{"type":"string","format":"cidr"},"explode":"true"}]}}},"tags":[{"name":"WHM Access","description":"Security / WHM Access"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.107.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2"},"execute_remote_whmapi1_with_password":{"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.91.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"API Development Tools / API Execution","name":"API Execution"}],"paths":{"/execute_remote_whmapi1_with_password":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  execute_remote_whmapi1_with_password \\\n  host='host.example.com' \\\n  username='username' \\\n  password='luggage12345' \\\n  function='passwd' \\\n  parameter_name='user' \\\n  parameter_value='username2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/execute_remote_whmapi1_with_password?api.version=1&host=host.example.com&username=username&password=luggage12345&function=passwd&parameter_name=user&parameter_value=username2"}],"tags":["API Execution"],"summary":"Run remote WHM API 1 function","x-cpanel-api-version":"WHM API 1","parameters":[{"schema":{"type":"string","example":"host.example.com"},"description":"The remote server's hostname or IP address.","required":"true","in":"query","name":"host"},{"description":"The username to log in to the remote server.","schema":{"type":"string","example":"username"},"in":"query","name":"username","required":"true"},{"name":"password","in":"query","required":"true","description":"The password to log in to the remote server.","schema":{"example":"luggage12345","type":"string"}},{"description":"The name of the function to call on the remote server.","schema":{"type":"string","example":"passwd"},"in":"query","name":"function","required":"true"},{"description":"Whether to use TLS verification. This parameter defaults to On.\n\n**Important:**\n\n We strongly recommend that you use TLS verification. Only connect to a server if you can verify its identity.","schema":{"type":"string","example":"on"},"in":"query","name":"tls_verification","required":"false"},{"in":"query","name":"parameter_name","required":"true","description":"The name of the parameter for the function.\n\n**Note:**\n\n You must enter the same number of parameter_name and parameter_value parameters.","schema":{"type":"string","example":"user"}},{"schema":{"type":"string","example":"username2"},"description":"The value of the parameter for the function.\n\n**Note:**\n\n You must enter the same number of parameter_name and parameter_value parameters.","required":"true","in":"query","name":"parameter_value"}],"description":"This function executes WHM API 1 functions on a remote server.","operationId":"execute_remote_whmapi1_with_password","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"app":{"type":"array","items":{"type":"string"}},"key-name*":{"example":"system","description":"The function's output.\n\n**Note:**\n\n The system uses the remote function's return name. A valid possible values.","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","enum":["0","1"],"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details."},"command":{"type":"string","description":"The method name called.","example":"execute_remote_whmapi1_with_password"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"90"}}},"x-tagGroups":[{"name":"API Development Tools","tags":["API Execution"]}]},"start_transfer_session":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/start_transfer_session":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"pid":{"description":"The transfer session's process ID.","example":"90210","type":"integer","minimum":"1"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"start_transfer_session","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[{"required":"true","in":"query","name":"transfer_session_id","schema":{"example":"exampleservercopya20140206192428NtyW","type":"string"},"description":"The transfer session's ID."}],"operationId":"start_transfer_session","description":"This function starts or restarts a transfer session.\n\n**Note:**\n\n  For more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","x-cpanel-api-version":"WHM API 1","summary":"Start or restart transfer session","tags":["Transfers","cPanel Account Transfer"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  start_transfer_session \\\n  transfer_session_id='exampleservercopya20140206192428NtyW'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/start_transfer_session?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW"}]}}},"x-tagGroups":[{"tags":["cPanel Account Transfer"],"name":"Transfers"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"description":"Transfers / cPanel Account Transfer","name":"cPanel Account Transfer"}]},"read_cpgreylist_trusted_hosts":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"name":"Greylisting","description":"The Greylisting module for WHM API 1."},{"description":"Mail / Spam Protection (Greylisting)","name":"Spam Protection (Greylisting)"}],"paths":{"/read_cpgreylist_trusted_hosts":{"get":{"parameters":[],"operationId":"read_cpgreylist_trusted_hosts","description":"This function retrieves the entries on the Greylisting Trusted Hosts list.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"greylist_trusted_hosts":{"description":"An array of objects that contain identification information for the trusted hosts.","items":{"properties":{"comment":{"maximum":"255","type":"string","example":"Example","description":"The IP address' comment."},"id":{"description":"The identification number that the system assigned to the IP address.","example":"19","minimum":"1","type":"integer"},"host_ip":{"description":"The IP address of the host that the system added to the _Trusted Hosts_ list.","format":"ipv4","example":"192.0.2.0","type":"string"},"create_time":{"format":"ISO-8601 Date Time (Space Separated)","description":"The date and time when the system added the IP address to the _Trusted Hosts_ list.","example":"2015-03-24T10:22:38.000Z","type":"string"}},"type":"object"},"type":"array"}}},"metadata":{"properties":{"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"read_cpgreylist_trusted_hosts"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"11.50","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  read_cpgreylist_trusted_hosts\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/read_cpgreylist_trusted_hosts?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"summary":"Return Greylisting trusted hosts","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Protection (Greylisting)"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"gethostname":{"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"System Information","description":"Server Administration / System Information"}],"paths":{"/gethostname":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  gethostname\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/gethostname?api.version=1"}],"tags":["Server Administration","System Information"],"summary":"Return server's hostname","x-cpanel-api-version":"WHM API 1","operationId":"gethostname","description":"This function retrieves the server's hostname.","parameters":[],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"hostname":{"example":"hostname.example.com","description":"The server's hostname.","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"example":"gethostname","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["System Information"],"name":"Server Administration"}]},"ea4_get_additional_pkg_prefixes":{"paths":{"/ea4_get_additional_pkg_prefixes":{"get":{"description":"This function returns any additional package prefixes set up in the `/etc/cpanel/ea4/additional-pkg-prefixes/` file.","operationId":"ea4_get_additional_pkg_prefixes","parameters":[],"x-cpanel-available-version":"116","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"ea4_get_additional_pkg_prefixes"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"type":"object","properties":{"additional_pkg_prefixes":{"type":"array","description":"A list of any additional package prefixes, beyond `ea`, that the server is using.","items":{"type":"string","example":"altea"}}}}},"type":"object"}}}}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty ea4_get_additional_pkg_prefixes\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_get_additional_pkg_prefixes?api.version=1"}],"tags":["EasyApache","EasyApache Settings"],"summary":"Return any additional package prefixes, beyond `ea`.","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["EasyApache Settings"],"name":"Web Server Configuration"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"EasyApache","description":"The EasyApache module for WHM API 1."},{"name":"EasyApache Settings","description":"Web Server Configuration / EasyApache Settings"}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_rpm_version_data":{"x-tagGroups":[{"name":"System Package Management","tags":["List Package Information"]}],"paths":{"/get_rpm_version_data":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"description":"The method name called.","example":"get_rpm_version_data","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}},"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":[{"example":{"3rdparty":["cpanel-pcre","cpanel-pixman","cpanel-analog"]},"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"}},{"additionalProperties":{"type":"object","additionalProperties":{"items":{"type":"string"},"description":"A list of all available RPMs. The system uses the RPM key's name as the return name.","type":"array"},"description":"A list containing the RPM section's RPM information. The system uses the RPM section name as the return name."},"example":{"rpm_groups":{"3rdparty":["cpanel-pcre","cpanel-pixman","cpanel-analog"]}}}]}},"type":"object"}}}}},"x-cpanel-available-version":"11.32","parameters":[{"name":"section","in":"query","required":"true","description":"The RPM's section.","schema":{"example":"rpm_groups","type":"string"}},{"description":"The RPM's key. If you do **not** specify a value, the function returns all RPM categories.","schema":{"example":"3rdparty","type":"string"},"in":"query","name":"key","required":"false"}],"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","x-cpanel-api-version":"WHM API 1","summary":"Return available RPM packages","tags":["RPM","List Package Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_rpm_version_data \\\n  section='rpm_groups'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_rpm_version_data?api.version=1&section=rpm_groups","label":"URL","lang":"HTTP"}]}}},"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"List Package Information","description":"System Package Management / List Package Information"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2"},"update_reverse_dns_cache":{"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/update_reverse_dns_cache":{"get":{"summary":"Update reverse DNS cache","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  update_reverse_dns_cache\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_reverse_dns_cache?api.version=1"}],"tags":["DNS","DNS Zones"],"x-cpanel-available-version":"86","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","description":"The method name called.","example":"update_reverse_dns_cache"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."}}}}}}}}},"description":"This function queries DNS and updates the map of local IP addresses to reverse DNS names.","operationId":"update_reverse_dns_cache","parameters":[]}}},"x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Zones","description":"DNS / DNS Zones"}]},"ea4_recommendations":{"paths":{"/ea4_recommendations":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"ea4_recommendations","type":"string"},"result":{"type":"integer","description":"- 1 - Success.\n- 0 - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"}}},"data":{"type":"object","additionalProperties":{"type":"array","items":{"properties":{"desc":{"type":"string","description":"The recommendation's description.\n\n**Note:**\n\n* The function **only** returns this value if it exists."},"level":{"enum":["primary","success","info","warning","danger"],"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`.","type":"string"},"url":{"type":"string","format":"url","description":"A URL to provide more information.\n\n**Note:**\n\n* The function **only** returns this value if it exists."},"name":{"description":"The recommendation's name.","type":"string"},"on":{"type":"string","description":"The action that triggers a recommendation.\n\n* `add`\n* `remove`","enum":["add","remove"]},"options":{"description":"An object that contains each option for the package's recommendations.","items":{"type":"object","properties":{"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"},"items":{"type":"array","items":{"type":"string"},"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"]},"recommended":{"type":"boolean","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"]},"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"},"text":{"description":"The text returned in the user interface.","type":"string"}}},"type":"array"}},"type":"object"},"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`."},"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","url":"https://www.example.com","on":"add","options":[{"text":"We strongly recommend that you install one of the following packages unless this is a single-user system:","recommended":"true","items":["ruid2","mpm-itk"],"level":"success"},{"level":"warning","recommended":"false","text":"If you use suPHP, you will add some security, but may experience performance issues on your server."}]}]}}},"type":"object"}}}}},"x-cpanel-available-version":"64","parameters":[],"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","summary":"Return EasyApache 4 recommendations","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ea4_recommendations\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_recommendations?api.version=1","lang":"HTTP","label":"URL"}],"tags":["EasyApache","EasyApache Settings"]}}},"x-tagGroups":[{"name":"Web Server Configuration","tags":["EasyApache Settings"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The EasyApache module for WHM API 1.","name":"EasyApache"},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"nginxmanager_clear_cache":{"tags":[{"name":"NGINX Manager","description":"The NGINX Manager module for WHM API 1."}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["NGINX Manager"],"name":"NGINX Manager"}],"paths":{"/nginxmanager_clear_cache":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"nginxmanager_clear_cache"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function clears a user's NGINX cache","operationId":"nginxmanager_clear_cache","parameters":[{"explode":"true","schema":{"type":"array","items":{"format":"username","type":"string"},"default":[],"format":"username","example":["unclebob","auntsue"]},"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.","style":"form","name":"user","in":"query","required":"false"}],"summary":"Delete the user's NGINX cache.","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  nginxmanager_clear_cache\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_clear_cache?api.version=1","label":"URL","lang":"HTTP"}],"tags":["NGINX Manager"]}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}}},"ticket_whitelist_unsetup":{"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"name":"Support Access","description":"cPanel Support Tickets / Support Access"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Support Access"],"name":"cPanel Support Tickets"}],"paths":{"/ticket_whitelist_unsetup":{"get":{"x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_whitelist_unsetup?api.version=1"}],"tags":["Support Tickets","Support Access"],"summary":"Remove Support IP addresses from firewall","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1","operationId":"ticket_whitelist_unsetup","description":"This function removes cPanel Support's IP addresses from your server's firewall\nwhitelist. This function is firewall-specific and does **not** change the\n[cPHulk](https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/)\nwhitelist.\n\n**Note:**\n\n* This function is **not** available through the command line. You **must** call it as\na request body.\n* This function logs error messages to the\n[`/usr/local/cpanel/logs/error_log`](https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#usr-local-cpanel-logs-error-log)\nfile.","parameters":[],"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"chain_status":{"type":"string","enum":["INACTIVE","ERR_UNSETUP"],"example":"INACTIVE","description":"A message that indicates whether the whitelist removal succeeded.\n\n* `INACTIVE` — Success.\n* `ERR_UNSETUP` — An error occurred."}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"example":"ticket_whitelist_unsetup","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_tcp6_sockets":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Connections","name":"Connections"}],"paths":{"/get_tcp6_sockets":{"get":{"operationId":"get_tcp6_sockets","description":"This function returns data about the system's transmission control protocol (TCP) IPv6 sockets.","parameters":[],"x-cpanel-available-version":"80","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"get_tcp6_sockets","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}},"data":{"properties":{"payload":{"description":"An array of objects that contains the status of the system's TCP IPv6 sockets.","items":{"type":"object","properties":{"inode":{"type":"integer","minimum":"1","description":"The inode number the Linux kernel assigned to the socket.","example":"27171"},"wqueue":{"description":"The number of bytes that the system is waiting to send.","format":"bytes","example":"45","type":"integer"},"sport":{"minimum":"1","type":"integer","description":"The source port number.","example":"2087"},"uid":{"minimum":"1","type":"integer","description":"The socket's user ID (UID).","example":"102"},"rqueue":{"example":"0","format":"bytes","description":"The number of bytes in the socket's read buffer.","type":"integer"},"dport":{"description":"The source port that the Linux kernel reports for the socket.","example":"443","minimum":"1","type":"integer"},"src":{"description":"The source IPv6 address.","format":"ipv6","example":"2001:0db8:0:0:1:0:0:2","type":"string"},"state":{"example":"10","description":"The socket's current state, in the Linux kernel's numeric format.","type":"integer","minimum":"1"},"dst":{"type":"string","description":"The destination IPv6 address.","format":"bytes","example":"2001:0db8:0:0:1:0:0:1"}}},"type":"array"}},"type":"object"}},"type":"object"}}}}},"tags":["Server Administration","Connections"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_tcp6_sockets\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_tcp6_sockets?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return TCP IPv6 sockets data"}}},"x-tagGroups":[{"tags":["Connections"],"name":"Server Administration"}]},"get_update_availability":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Updates","name":"Updates"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"paths":{"/get_update_availability":{"get":{"tags":["Server Administration","Updates"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_update_availability\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_update_availability?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return if server uses the default update version","parameters":[],"operationId":"get_update_availability","description":"This function checks whether your server uses the\n[latest version of cPanel & WHM for your release tier](https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/).","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"tier":{"example":"current","enum":["edge","current","release","stable","lts"],"description":"The server's\n[support tier](https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/#release-tiers):\n\n* `edge` — EDGE.\n* `current` — CURRENT.\n* `release` — RELEASE.\n* `stable` — STABLE.\n* `lts` — Long-Term Support (LTS).","type":"string"},"newest_version":{"example":"88.0.12","description":"The available version of cPanel & WHM available for the server's support tier.","type":"string"},"current_version":{"description":"The server's current version of cPanel & WHM.","example":"88.0.12","type":"string"},"update_available":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether a new version of cPanel & WHM is available for the server's support tier.\n\n- `1` — Available.\n- `0` — Not available."}}},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"get_update_availability","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"56"}}}},"set_autossl_metadata_key":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"paths":{"/set_autossl_metadata_key":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  set_autossl_metadata_key \\\n  key='notify_autossl_expiry' \\\n  value='1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_metadata_key?api.version=1&key=notify_autossl_expiry&value=1","label":"URL","lang":"HTTP"}],"tags":["SSL","Auto-Generated Certificates"],"summary":"Update AutoSSL metadata via JSON","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","in":"query","name":"key","schema":{"type":"string","enum":["clobber_externally_signed","notify_autossl_expiry","notify_autossl_expiry_coverage","notify_autossl_expiry_coverage_user","notify_autossl_renewal","notify_autossl_renewal_user","notify_autossl_renewal_coverage","notify_autossl_renewal_coverage_user","notify_autossl_renewal_coverage_reduced","notify_autossl_renewal_coverage_reduced_user","notify_autossl_renewal_uncovered_domains","notify_autossl_renewal_uncovered_domains_user"],"example":"notify_autossl_expiry"},"description":"The AutoSSL metadata key that you wish to modify.\n* `clobber_externally_signed` — 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.\n* `notify_autossl_expiry` — Whether to send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate.\n* `notify_autossl_expiry_coverage` — Whether to send a notification if at least one currently-secured domain will lose coverage when the certificate renews.\n* `notify_autossl_expiry_coverage_user `— Whether to send a notification if at least one currently-secured domain for a user will lose coverage when the certificate renews.\n* `notify_autossl_renewal` — Whether to send a notification when AutoSSL successfully renews a certificate.\n* `notify_autossl_renewal_user` — Whether to send a notification when AutoSSL successfully renews a certificate for a user.\n* `notify_autossl_renewal_coverage` — Whether to send a notification when a currently-secured domain fails DCV and the certificate has not reached its renewal period.\n* `notify_autossl_renewal_coverage_user` — Whether to send a notification when a user's currently-secured domain fails DCV and the certificate has not reached its renewal period.\n* `notify_autossl_renewal_coverage_reduced` — 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.\n* `notify_autossl_renewal_coverage_reduced_user` — 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.\n* `notify_autossl_renewal_uncovered_domains` — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.\n* `notify_autossl_renewal_uncovered_domains_user` — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains."},{"schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether to allow AutoSSL to replace certificates that it did not issue for the `clobber_externally_signed` parameter.\n\n**or**\n\nWhether to send a notification for the `notify_autossl_expiry`, `notify_autossl_expiry_coverage`, `notify_autossl_expiry_coverage_user`, `notify_autossl_renewal`, `notify_autossl_renewal_user`, `notify_autossl_renewal_coverage`, `notify_autossl_renewal_coverage`, `notify_autossl_renewal_coverage_reduced`, `notify_autossl_renewal_coverage_reduced_user`, `notify_autossl_renewal_uncovered_domains`, and `notify_autossl_renewal_uncovered_domains_user` parameters.\n* `1` — Allow or notify.\n* `0` — Do **not** allow or notify.\n\n**Note:**\n\n For reference, the system preconfigures AutoSSL metadata keys to the following values:\n * The value for `clobber_externally_signed` defaults to `0`.\n * The value for `notify_autossl_expiry` defaults to `1`.\n * The value for `notify_autossl_expiry_coverage` defaults to `1`.\n * The value for `notify_autossl_expiry_coverage_user` defaults to `1`.\n * The value for `notify_autossl_renewal` defaults to `1`.\n * The value for `notify_autossl_renewal_user` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage_user` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage_reduced` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage_reduced_user` defaults to `1`.\n * The value for `notify_autossl_renewal_uncovered_domains` defaults to `1`.\n * The value for `notify_autossl_renewal_uncovered_domains_user` defaults to `1`.","required":"true","name":"value","in":"query"}],"description":"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.\n\n**Note:**\n\n  * This function performs the same actions as the WHM API 1 `set_autossl_metadata` function. However, this function accepts a single key and value pair as a parameter instead of JSON. Additionally, you can **only** enter one key and value pair per function call.\n  * This function **only** accepts a single key and value pair. To set all values, use the WHM API 1 `set_autossl_metadata` function or make multiple calls to this function.","operationId":"set_autossl_metadata_key","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_autossl_metadata_key","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"70"}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"cpgreylist_trust_entries_for_common_mail_provider":{"tags":[{"name":"Greylisting","description":"The Greylisting module for WHM API 1."},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"name":"Mail","tags":["Spam Protection (Greylisting)"]}],"paths":{"/cpgreylist_trust_entries_for_common_mail_provider":{"get":{"parameters":[{"required":"true","in":"query","name":"provider","schema":{"example":"cpanel","type":"string"},"description":"The mail providers’ names.\n\nCall the `cpgreylist_load_common_mail_providers_config` API function\nto retrieve the system’s recognized provider names.\n\n**Note:**\n\n To trust multiple mail providers, increment the parameter name (for example: `provider-0`, `provider-1`, and `provider-2`).","examples":{"multiple":{"value":"provider-1=cpanel&provider-2=google","summary":"Trust multiple mail providers."},"single":{"summary":"Trust a single mail provider.","value":"cpanel"}}}],"operationId":"cpgreylist_trust_entries_for_common_mail_provider","description":"This function marks the IP addresses for the specified mail provider as trusted. Greylisting will not defer emails from trusted IP addresses.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"providers_trusted":{"description":"The mail providers that Greylisting trusts.","additionalProperties":{"description":"The providers whose configuration changes succeeded.\n\n**Note:**\n\nThe property’s keys are the provider name.","properties":{"ips_trusted":{"description":"The total number of the mail provider's IP addresses that Greylisting trusts.","example":"21","type":"integer","minimum":"1"}},"type":"object"},"type":"object"},"providers_failed":{"type":"object","additionalProperties":{"type":"string","description":"The reason for the provider’s failure.\n\n**Note:**\n\nThe property’s keys are the provider name.","example":"This failed because it rained."},"description":"The providers whose configuration changes failed."}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"example":"cpgreylist_trust_entries_for_common_mail_provider","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_trust_entries_for_common_mail_provider \\\n  provider='cpanel'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_trust_entries_for_common_mail_provider?api.version=1&provider=cpanel"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"summary":"Add mail provider to Greylisting trusted hosts","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"get_market_providers_commission_config":{"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Market","description":"The Market module for WHM API 1."},{"description":"cPanel Market / Provider Management","name":"Provider Management"}],"paths":{"/get_market_providers_commission_config":{"get":{"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","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":{"type":"string","example":"user@example.com","format":"email","description":"The locally-cached commission ID that the server owner uses for the cPanel Market provider."},"provider_display_name":{"type":"string","description":"The cPanel Market provider's display name.","example":"cPanel Store"},"remote_commission_id":{"example":"user@example.com","description":"The commission ID that the server owner uses for the cPanel Market provider.","format":"email","type":"string"},"provider_name":{"example":"cPStore","description":"The cPanel Market provider's name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"example":"get_market_providers_commission_config","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"description":"This function returns the commission configuration of all available cPanel Market providers.","operationId":"get_market_providers_commission_config","parameters":[],"summary":"Return Market providers' commission configuration","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_market_providers_commission_config\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_commission_config?api.version=1"}],"tags":["Market","Provider Management"]}}},"x-tagGroups":[{"tags":["Provider Management"],"name":"cPanel Market"}]},"restore_queue_list_pending":{"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"name":"Restore Queue Reporting","description":"Account Restoration / Restore Queue Reporting"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Restore Queue Reporting"],"name":"Account Restoration"}],"paths":{"/restore_queue_list_pending":{"get":{"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":{"properties":{"destid":{"example":"LmTZCUpqqLSPH8AO7pVtIeNK","description":"The destination's identification string.\n\n* `local` — The local directory.\n* The destination ID string's value.","type":"string"},"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"},"give_ip":{"enum":["0","1"],"example":"1","description":"Whether the task will assign the account a dedicated IP address.\n\n* `1` — Assign.\n* `0` — Will **not** assign.","type":"integer"},"mysql":{"example":"1","enum":["0","1"],"description":"Whether the task will restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","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","description":"A list of information about the options for a pending task in the restoration queue."},"restore_point":{"type":"string","format":"ISO-8601 Date","description":"The date of the backup that the task will use, in `YYYY-MM-DD` format.","example":"2015-10-21T00:00:00.000Z"},"user":{"example":"username","description":"The cPanel account's username.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"restore_queue_list_pending","description":"The method name called."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38","parameters":[],"operationId":"restore_queue_list_pending","description":"This function lists the tasks that the restoration queue has not yet processed.","summary":"Return pending restoration tasks list","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_list_pending\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_list_pending?api.version=1"}],"tags":["Account Restoration","Restore Queue Reporting"]}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."}},"load_cpgreylist_config":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/load_cpgreylist_config":{"get":{"x-cpanel-available-version":"11.50","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"cpgreylist_config":{"description":"An object that contains Greylisting settings.","properties":{"purge_interval_mins":{"example":"60","description":"The number of minutes before Greylisting deletes the records in the Greylisting database.","type":"integer","minimum":"1"},"is_exim_enabled":{"example":"1","enum":["0","1"],"description":"Whether Exim is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"record_exp_time_mins":{"example":"4320","description":"The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet.","minimum":"1","maximum":"43200","type":"integer"},"child_timeout_secs":{"type":"integer","minimum":"1","description":"The maximum amount of seconds that Greylisting waits for a child process to time out.","example":"5"},"initial_block_time_mins":{"type":"integer","maximum":"240","minimum":"1","description":"The number of minutes during which Greylisting defers email from an unknown triplet.","example":"10"},"must_try_time_mins":{"maximum":"1440","type":"integer","minimum":"1","example":"240","description":"The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet."},"is_enabled":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether Greylisting is enabled.\n* `1` — Enabled.\n* `0` — Disabled."},"max_child_procs":{"description":"The maximum amount of child processes.","example":"5","minimum":"1","type":"integer"},"spf_bypass":{"enum":["0","1"],"example":"1","description":"Whether emails with SPF bypass Greylisting.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"}},"type":"object"}}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"load_cpgreylist_config","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"operationId":"load_cpgreylist_config","description":"This function returns Greylisting's current settings.","parameters":[],"summary":"Return Greylisting settings","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  load_cpgreylist_config\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/load_cpgreylist_config?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Greylisting","Spam Protection (Greylisting)"]}}},"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}]},"twofactorauth_get_user_configs":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}],"paths":{"/twofactorauth_get_user_configs":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"properties":{"primary_domain":{"example":"example.com","description":"The account's primary domain.","format":"domain","type":"string"},"is_enabled":{"description":"Whether the account has 2FA enabled.\n* `1` - Enabled.\n* `0` - **Not** enabled.","example":"1","enum":["0","1"],"type":"integer"}},"type":"object","description":"An object that contains a hash of the account's data."},"description":"The data that the function returns.","example":{"example":{"primary_domain":"example.com","is_enabled":"0"}}},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"twofactorauth_get_user_configs","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"54","parameters":[{"description":"The username for a specified account.\n\n**Note:**\n\nIf you do **not** specify a value, the function returns **all** user accounts.","schema":{"type":"string","format":"username","example":"example"},"name":"user","in":"query","required":"false"}],"description":"This function returns a list of user-controlled accounts and whether the accounts have Two-Factor Authentication (2FA) enabled.","operationId":"twofactorauth_get_user_configs","x-cpanel-api-version":"WHM API 1","summary":"Return cPanel accounts with 2FA enabled","tags":["Authentication","Two-Factor Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_get_user_configs\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_get_user_configs?api.version=1","lang":"HTTP","label":"URL"}]}}},"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}]},"emailtrack_stats":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["cPanel Account Mail Management"],"name":"Mail"}],"paths":{"/emailtrack_stats":{"get":{"parameters":[{"schema":{"type":"string","example":"username"},"description":"The cPanel username to query. If you do not specify a value, the function retrieves statistics for all of the server's accounts.","required":"false","name":"user","in":"query"},{"description":"The start time of the search window.\n\n**Note**\n\nYou can also call this the `startdate` parameter.","schema":{"type":"integer","example":"1371552781","default":"0","format":"unix_timestamp"},"name":"starttime","in":"query","required":"false"},{"name":"startdate","in":"query","required":"false","description":"The start date of the search window.\n\n**Note**\n\nThis parameter is an alias for `starttime` and is provided for backwards compatibility.","schema":{"example":"1371552781","format":"unix_timestamp","default":"0","type":"integer"}},{"in":"query","name":"endtime","required":"false","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.","schema":{"type":"integer","format":"unix_timestamp","example":"1471552781"}},{"in":"query","name":"enddate","required":"false","description":"The end date of the search window. This parameter defaults to the current time.\n\n**Note**\n\nThis parameter is an alias for `endtime` and is provided for backwards compatibility.","schema":{"example":"1471552781","format":"unix_timestamp","type":"integer"}},{"schema":{"example":"remote","enum":["remote","remote-or-faildefer","local"],"type":"string"},"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`","required":"false","in":"query","name":"deliverytype"},{"required":"false","name":"nosuccess","in":"query","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"description":"Whether to return the `SUCCESSCOUNT` parameter.\n* 1 — Do **not** return.\n* 0 — Return."},{"description":"Whether to return the `TOTALSIZE` parameter.\n* 1 — Do **not** return.\n* 0 — Return.","schema":{"type":"integer","example":"0","enum":["0","1"],"default":"0"},"in":"query","name":"nosize","required":"false"}],"description":"This function retrieves email tracking statistics.","operationId":"emailtrack_stats","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"records":{"type":"array","description":"An array of objects containing the message information.","items":{"type":"object","properties":{"TOTALSIZE":{"example":"27444","description":"The total size of messages that the server sent.","format":"bytes","minimum":"0","type":"integer"},"SUCCESSCOUNT":{"type":"integer","example":"14","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."},"DEFERCOUNT":{"example":"0","description":"The number of deferral events.","minimum":"0","type":"integer"},"INPROGRESSCOUNT":{"example":"0","description":"The number of messages currently in progress.","type":"integer","minimum":"0"},"SENDCOUNT":{"type":"integer","minimum":"0","example":"14","description":"The number of sent messages."},"DEFERFAILCOUNT":{"description":"The number of messages that the system deferred and failed to deliver.","example":"0","minimum":"0","type":"integer"},"FAILCOUNT":{"type":"integer","minimum":"0","example":"0","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."}}}}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"example":"emailtrack_stats","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}}}}}}},"x-cpanel-available-version":"11","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  emailtrack_stats\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_stats?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Return cPanel account email tracking statistics","x-cpanel-api-version":"WHM API 1"}}}},"remove_integration_link":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"tags":[{"name":"Integration","description":"The Integration module for WHM API 1."},{"description":"Integrations / Links","name":"Links"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Integrations","tags":["Links"]}],"paths":{"/remove_integration_link":{"get":{"operationId":"remove_integration_link","description":"This function removes an integration link from the cPanel interface.","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account name.","schema":{"format":"username","example":"username","type":"string"}},{"in":"query","name":"app","required":"true","description":"The name of the integration link to remove.","schema":{"example":"WHMCS_billing","type":"string"}}],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"remove_integration_link","description":"The method name called.","type":"string"}}},"data":{}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["Integration","Links"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remove_integration_link \\\n  user='username' \\\n  app='WHMCS_billing'\n","label":"CLI","lang":"Shell"},{"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","summary":"Remove integration link"}}}},"allow_all_whm_root_access":{"openapi":"3.0.2","info":{"version":"11.107.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"WHM","description":"Security / WHM Access"}],"paths":{"/allow_all_whm_root_access":{"get":{"operationId":"allow_all_whm_root_access","description":"This function removes all restrictions to root login to cPanel & WHM login based on IP.","tags":["WHM Access"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  allow_all_whm_root_access\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/allow_all_whm_root_access?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"108","x-cpanel-api-version":"WHM API 1","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"allow_all_whm_root_access"}}}}}}},"description":"HTTP Request was successful."}},"summary":"Clear all CIDR restrictions to login to cPanel & WHM with the root password."}}},"x-tagGroups":[{"name":"Security","tags":["WHM Access"]}]},"set_service_proxy_backends":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.91.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Services"],"name":"Server Administration"}],"paths":{"/set_service_proxy_backends":{"get":{"tags":["Services"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  set_service_proxy_backends \\\n  username='example'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_service_proxy_backends?api.version=1&username=example","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update cPanel account service proxying","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.","schema":{"format":"username","example":"example","type":"string"},"name":"username","in":"query","required":"true"},{"required":"false","name":"general","in":"query","schema":{"anyOf":[{"type":"string","format":"hostname","description":"A valid hostname.","example":"hostname.example.com"},{"format":"ipv4","description":"A valid IP address.","example":"192.0.2.102","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."},{"schema":{"enum":["Mail"],"type":"string"},"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"}},"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`.","required":"false","in":"query","name":"service_group"},{"required":"false","name":"service_group_backend","in":"query","schema":{"anyOf":[{"description":"A valid hostname.","format":"hostname","example":"hostname.example.com","type":"string"},{"description":"A valid IP address.","format":"ipv4","example":"192.0.2.102","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"}}}],"x-cpanel-available-version":"90","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"example":"set_service_proxy_backends","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Services","name":"Services"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"add_services_cluster_node":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"name":"ServicesCluster","description":"The ServicesCluster module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"name":"ServicesCluster","tags":["ServicesCluster"]}],"paths":{"/add_services_cluster_node":{"get":{"parameters":[{"description":"The external server‘s hostname or IP address.","schema":{"oneOf":[{"format":"ipv4","type":"string"},{"format":"hostname","type":"string"}],"example":"192.168.0.1"},"name":"host","in":"query"},{"in":"query","name":"is_agent","description":"Whether or not the node should act as an agent node.\n\n**Important:**\n\nA node cannot be both an agent and a server.\n\n* `1` - The node should act as an agent in the cluster.\n* `0` - The node should not as an agent in the cluster.","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"}},{"name":"is_server","in":"query","description":"Whether or not the node should act as a server node.\n\n**Important:**\n\nA node cannot be both an agent and a server.\n\n* `1` - The node should act as a server in the cluster\n* `0` - The node should not as a server in the cluster","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]}},{"in":"query","name":"comment","schema":{"example":"This is my favorite cluster node.","type":"string"},"description":"A free-form note about this cluster node."}],"x-cpanel-internal-only":"true","operationId":"add_services_cluster_node","description":"This function adds an external server as a services cluster node.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"add_services_cluster_node","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.110","tags":["ServicesCluster"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  add_services_cluster_node \\\n  host='node1.example.com' \\\n  is_agent=0 \\\n  is_server=1 \\\n  comment='This is my favorite cluster node' \\\n  label-key='my-label-key' \\\n  label-value='my-label-value'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/add_services_cluster_node?api.version=1&host=node1.example.com&is_agent=0&is_server=1&comment=This%20is%20my%20favorite%20cluster%20node&label-key=my-label-key&label-value=my-label-value","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Add a new node to the services cluster."}}}},"listpkgs":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Hosting Plans","description":"Hosting Plans / Hosting Plans"}],"servers":[{"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."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Hosting Plans"],"name":"Hosting Plans"}],"paths":{"/listpkgs":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"pkg":{"type":"array","items":{"properties":{"MAX_EMAILACCT_QUOTA":{"example":"unlimited","description":"The hosting plan's maximum email account quota size, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows an unlimited email account quota size.","oneOf":[{"minimum":"0","type":"integer"},{"type":"string","description":"The hosting plan allows an unlimited email account quota size.","enum":["unlimited"]}]},"MAX_TEAM_USERS":{"nullable":"true","description":"The hosting plan's maximum number of Team users.","example":"7","type":"integer","maximum":"7","minimum":"0"},"FEATURELIST":{"description":"The hosting plan's [feature list](https://go.cpanel.net/whmdocsFeatureManager).","example":"myfeaturelist","type":"string"},"HASSHELL":{"description":"Whether shell access is enabled for the hosting plan.\n\n* `y` — Enabled.\n* `n` — Disabled.","example":"n","enum":["y","n"],"type":"string"},"_PACKAGE_EXTENSIONS":{"example":"","description":"A space-separated list of one or more of the hosting plan's package extensions, if any exist.","type":"string"},"MAXSUB":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","description":"The hosting plan allows unlimited subdomains.","enum":["unlimited"]}],"example":"unlimited","description":"The hosting plan's maximum number of subdomains.\n\n* `unlimited` — The hosting plan allows unlimited subdomains."},"CPMOD":{"example":"jupiter","description":"The hosing plan's cPanel interface theme.","type":"string"},"name":{"type":"string","description":"The hosting plan's name.","example":"package1"},"MAX_DEFER_FAIL_PERCENTAGE":{"description":"The\n[percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send per hour before the system rate-limits\noutgoing mail.\n\n* `unlimited` — The hosting plan allows unlimited email messages.","example":"unlimited","oneOf":[{"minimum":"0","type":"integer"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited email messages.","type":"string"}]},"QUOTA":{"description":"The hosting plan's disk space limit, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows unlimited disk space.","example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited disk space.","type":"string"}]},"MAXLST":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows an unlimited number of mailing lists."}],"example":"unlimited","description":"The hosting plan's maximum number of mailing lists.\n\n* `unlimited` — The hosting plan allows an unlimited number of mailing lists."},"MAXPOP":{"oneOf":[{"minimum":"0","type":"integer"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited email accounts.","type":"string"}],"description":"The hosting plan's maximum number of email accounts.\n\n* `unlimited` — The hosting plan allows unlimited email accounts.","example":"unlimited"},"MAXFTP":{"oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited FTP accounts.","enum":["unlimited"],"type":"string"}],"example":"unlimited","description":"The hosting plan's maximum number of FTP accounts.\n\n* `unlimited` — The hosting plan allows unlimited FTP accounts."},"DIGESTAUTH":{"description":"Whether the hosting plan enables Digest Authentication.\n\n* `y` — Enabled.\n* `n` — Disabled.","example":"n","enum":["y","n"],"type":"string"},"BWLIMIT":{"description":"The hosting plan's bandwidth limit, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows unlimited bandwidth.","example":"unlimited","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited bandwidth.","enum":["unlimited"],"type":"string"}]},"MAX_EMAIL_PER_HOUR":{"description":"The\n[maximum number of emails](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send in one hour.\n\n* `unlimited` — The hosting plan allows unlimited emails per hour.","example":"unlimited","oneOf":[{"minimum":"0","type":"integer"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows unlimited emails per hour."}]},"CGI":{"type":"string","example":"y","enum":["y","n"],"description":"Whether CGI is enabled for the hosting plan.\n\n* `y` — Enabled.\n* `n` — Disabled."},"MAXPARK":{"example":"unlimited","description":"The hosting plan's maximum number of parked domains (aliases).\n\n* `unlimited` — The hosting plan allows unlimited parked domains.","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited parked domains.","enum":["unlimited"],"type":"string"}]},"MAXADDON":{"example":"unlimited","description":"The hosting plan's maximum number of addon domains.\n\n* `unlimited` — The hosting plan allows unlimited addon domains.","oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited addon domains.","enum":["unlimited"],"type":"string"}]},"IP":{"description":"Whether the hosting plan grants accounts a dedicated IP address.\n\n* `y` — Dedicated IP address.\n* `n` — Shared IP address.","enum":["y","n"],"example":"n","type":"string"},"LANG":{"example":"en","description":"The hosting plan's locale.","format":"ISO-3166-1 (alpha-2)","type":"string"},"MAXSQL":{"example":"unlimited","description":"The hosting plan's maximum number of each available type of SQL\ndatabase.\n\nFor example, if this value is `5`, and the system administrator\nallows MySQL® and PostgreSQL® databases, users can create up to\nfive MySQL databases and up to five PostgreSQL databases.\n\n* `unlimited` — The hosting plan allows unlimited SQL databases.","oneOf":[{"minimum":"0","type":"integer"},{"type":"string","description":"The hosting plan allows unlimited SQL databases.","enum":["unlimited"]}]}},"type":"object"},"description":"An array of objects that contains hosting plans and their settings."}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"command":{"type":"string","example":"listpkgs","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}}}}}}},"x-cpanel-available-version":"11","parameters":[{"in":"query","name":"want","required":"false","description":"The permissions of packages that you wish to list.\n\n* `all` — All packages on the system.\n* `creatable` — Packages that the authenticated user can use for accounts.\n* `editable` — Packages that the authenticated user can edit.\n* `viewable` — Packages that the authenticated user can view.","schema":{"type":"string","example":"all","enum":["all","creatable","editable","viewable"],"default":"all"}}],"description":"This function lists the authenticated user's available hosting plans (packages).\n\n**Important:**\n\nThis function **only** returns packages that the authenticated user can access and\nuse during account creation.","operationId":"listpkgs","x-cpanel-api-version":"WHM API 1","summary":"Return current user's available hosting plans","tags":["Packages","Hosting Plans"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  listpkgs\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listpkgs?api.version=1"}]}}}},"restartservice":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"name":"Server Administration","tags":["Services"]}],"paths":{"/restartservice":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"service":{"type":"string","example":"exim","description":"The restarted service."},"output":{"type":"string","description":"The function's raw output.\n\n**Note:**\n\nIf you call the `queue_task` parameter, this changes the return's output:\n\n* `1` — Nothing.\n* `0` — A string of raw output.","example":"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"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"restartservice","description":"The method name called."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38","parameters":[{"description":"The service to restart. For a list of possible values, read our\n[Access Control List (ACL)](https://go.cpanel.net/ACLReferenceChart)\ndocumentation.","schema":{"example":"exim","type":"string"},"in":"query","name":"service","required":"true"},{"schema":{"default":"0","enum":["0","1"],"example":"0","type":"integer"},"description":"Whether to queue this task.\n\n* `1` — Queue.\n* `0` — Do **not** queue.\n\n**Note:**\n\nThis parameter affects the `output` return.","required":"false","in":"query","name":"queue_task"}],"operationId":"restartservice","description":"This function restarts a service, or daemon, on a server.\n\n**Note:**\n\nIf the user **only** possesses the `clustering`\n[Access Control List (ACL)](https://go.cpanel.net/ACLReferenceChart)\nthen this function can **only** act on the `named` service.","x-cpanel-api-version":"WHM API 1","summary":"Restart service","tags":["Server Administration","Services"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restartservice \\\n  service='exim'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/restartservice?api.version=1&service=exim"}]}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Services","name":"Services"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"ticket_revoke":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"name":"cPanel Support Tickets","tags":["Support Access"]}],"paths":{"/ticket_revoke":{"get":{"summary":"Delete Support SSH key","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_revoke?api.version=1&ticket_id=999999999&server_num=1&ssh_username=username","lang":"HTTP","label":"URL"}],"tags":["Support Tickets","Support Access"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"csf_wl_status":{"type":"string","description":"The status of the\n[ConfigServer Security & Firewall (CSF)](https://www.configserver.com/)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate CSF whitelist entries or they\nalready existed.\n* `INACTIVE` — The CSF whitelist entries were successfully removed or they\nwere already deleted.\n* `ERR_SETUP` — The system failed to add the CSF whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the CSF whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.\n\n**Note:**\n\nIf CSF does not exist on the server, the function will **not**\ndisplay this return.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"]},"hulk_wl_status":{"example":"ACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"description":"The status of the\n[cPHulk](https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate cPHulk whitelist entries or they\nalready existed.\n* `INACTIVE` — The cPHulk whitelist entries were successfully removed or they\nwere already deleted.\n* `ERR_SETUP` — The system failed to add the cPHulk whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the cPHulk whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.","type":"string"},"ticket_id":{"description":"The revoked support ticket's ID number.","example":"999999999","minimum":"1","type":"integer"},"chain_status":{"type":"string","description":"The status of the\n[`iptables`](https://netfilter.org/projects/iptables/index.html)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate whitelist entries or they\nalready existed.\n* `INACTIVE` — The whitelist entries were successfully removed or were\nalready deleted.\n* `ERR_SETUP` — The system failed to add the whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"]},"server_num":{"description":"The server's ID number.","example":"2","minimum":"1","type":"integer"},"non_fatals":{"type":"array","items":{"enum":["ticket_system_log_entry","audit_log"],"type":"string"},"description":"Any non-fatal errors.\n\n* `ticket_system_log_entry` — The function could not record the grant operation\nin the ticket.\n* `audit_log` — The function could not record the grant operation in the local\naudit log.\n\n**Note:**\n\nThe system stores the local audit log in the\n`/var/cpanel/logs/supportauth/audit.log` file.","example":[]},"host_access_wl_status":{"description":"The status of the `/etc/hosts.allow` file's whitelist\nentries.\n\n* `ACTIVE` — The system added the appropriate `/etc/hosts.allow` file whitelist\nentries or they already existed.\n* `INACTIVE` — The `/etc/hosts.allow` file whitelist entries were successfully\nremoved or they were already deleted.\n* `ERR_SETUP` — The system failed to add the `/etc/hosts.allow` file whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the `/etc/hosts.allow` file whitelist\nentries.\n* `ERR_UNKNOWN` — An unknown error occurred.                          ","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"example":"ACTIVE","type":"string"},"revoked_keys":{"example":"1","description":"The total number of revoked SSH keys.","minimum":"1","type":"integer"},"ssh_username":{"description":"The username for incoming SSH connections before they escalate to the `root` user.","example":"username","type":"string"}},"type":"object"},"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"ticket_revoke"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"11.44","parameters":[{"schema":{"example":"999999999","type":"integer","minimum":"1"},"description":"The support ticket's ID number.","required":"true","name":"ticket_id","in":"query"},{"schema":{"example":"1","type":"integer","minimum":"1"},"description":"The server's ID number.","required":"true","name":"server_num","in":"query"},{"required":"true","name":"ssh_username","in":"query","schema":{"example":"username","type":"string"},"description":"The username for incoming SSH connections before they escalate to the `root` user."}],"description":"This function removes a\n[cPanel Customer Portal](https://tickets.cpanel.net/)\nSSH key from the server.\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call it\nas a request body.","operationId":"ticket_revoke"}}},"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"description":"cPanel Support Tickets / Support Access","name":"Support Access"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"abort_transfer_session":{"paths":{"/abort_transfer_session":{"get":{"tags":["Transfers","cPanel Account Transfer"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  abort_transfer_session \\\n  transfer_session_id='exampleservercopya20140206192428NtyW'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/abort_transfer_session?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW"}],"x-cpanel-api-version":"WHM API 1","summary":"Stop transfer session","parameters":[{"name":"transfer_session_id","in":"query","required":"true","description":"The transfer session's ID.","schema":{"type":"string","example":"exampleservercopya20140206192428NtyW"}}],"operationId":"abort_transfer_session","description":"This function aborts an active transfer session.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"abort_transfer_session","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"11.44"}}},"x-tagGroups":[{"name":"Transfers","tags":["cPanel Account Transfer"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"name":"cPanel Account Transfer","description":"Transfers / cPanel Account Transfer"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"unset_nsec3_for_domains":{"x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"paths":{"/unset_nsec3_for_domains":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/unset_nsec3_for_domains?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"unset_nsec3_for_domains","description":"The method name called.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"domains":{"description":"An array of objects that contain information about each domain.","items":{"properties":{"domain":{"example":"example.com","description":"The domain for which to disable NSEC3.","type":"string"},"disabled":{"type":"integer","description":"Whether the system disabled NSEC3.\n* `1` — Disabled.\n* `0` — The system failed to disable NSEC3.","example":"1","enum":["0","1"]},"error":{"type":"string","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":"object"},"type":"array"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"86","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","example":"example.com"},"description":"The domain for which to disable NSEC3 semantics and use NSEC semantics."}],"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"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"Domain Management","description":"DNS / Domain Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"modsec_disable_vendor_updates":{"paths":{"/modsec_disable_vendor_updates":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_disable_vendor_updates \\\n  vendor_id='example'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor_updates?api.version=1&vendor_id=example"}],"tags":["ModSecurity","Rule Vendor Settings"],"summary":"Disable ModSecurity vendor updates","x-cpanel-api-version":"WHM API 1","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":[{"in":"query","name":"vendor_id","required":"true","description":"The vendor's unique short name.","schema":{"example":"example","type":"string"}}],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"modsec_disable_vendor_updates"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_cphulk_user_brutes":{"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"paths":{"/get_cphulk_user_brutes":{"get":{"x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"user_brutes":{"description":"Information about each brute force attempt.","items":{"properties":{"ip":{"anyOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}],"example":"192.168.0.1","description":"The IP address of the login attempt."},"service":{"type":"string","example":"ftp","description":"The name of the service on which the login attempt occurred."},"user":{"example":"example","description":"The username for which login attempt occurred.","type":"string"},"timeleft":{"example":"14","description":"The number of minutes that remain before cPHulk removes the block.","type":"integer"},"logintime":{"description":"When the login attempt occurred.","format":"ISO-8601 Date Time (Space Separated)","example":"2014-11-20T00:00:00.000Z","type":"string"},"exptime":{"format":"ISO-8601 Date Time (Space Separated)","description":"When the login request will time out.","example":"2014-12-07T00:00:00.000Z","type":"string"},"authservice":{"type":"string","example":"dovecot","description":"The authentication service on which the login attempt occurred."}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"command":{"example":"get_cphulk_user_brutes","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."}}}},"type":"object"}}}}},"operationId":"get_cphulk_user_brutes","description":"This function lists brute force attack entries from the cPHulk database, ordered by user accounts.","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return login security brute force attacks by user","tags":["cPHulk","Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_cphulk_user_brutes\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_cphulk_user_brutes?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Reporting"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"description":"Login Security (cPHulk) / Reporting","name":"Reporting"}]},"transfer_module_schema":{"x-tagGroups":[{"name":"Transfers","tags":["Transfer Configuration"]}],"paths":{"/transfer_module_schema":{"get":{"operationId":"transfer_module_schema","description":"This function retrieves a transfer module's key structure.\n\n**Note:**\n\nFor more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","parameters":[{"description":"The transfer module's name.\n\n* `AccountLocal`\n* `AccountRemoteRoot`\n* `AccountRemoteUser`\n* `FeaturesListRemoteRoot`\n* `LegacyAccountBackup`\n* `PackageRemoteRoot`","schema":{"type":"string","example":"AccountRemoteRoot","enum":["AccountLocal","AccountRemoteRoot","AccountRemoteUser","FeaturesListRemoteRoot","LegacyAccountBackup","PackageRemoteRoot"]},"name":"module","in":"query","required":"true"}],"x-cpanel-available-version":"cPanel 11.44","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"transfer_module_schema"}}},"data":{"type":"object","properties":{"schema":{"description":"An object containing information about the schema's keys.","type":"object","properties":{"keys":{"type":"object","additionalProperties":{"properties":{"def":{"type":"string","example":"char(255) DEFAULT NULL","description":"The first value is the parameter's type and length:\n\n* `int`\n* `char`\n* `bigint`\n* `text`\n\nThe second value is the default prepended by the word `DEFAULT`."}},"type":"object","description":"An object containing the key's information.\n\n**Note:**\n\nThe key's name is the return's name."},"description":"An object containing the schema's keys.","example":{"overwrite_sameowner_dbusers":{"def":"int(1) DEFAULT 0"},"overwrite_with_delete":{"def":"int(1) DEFAULT 0"},"copypoint":{"def":"text"},"skipacctdb":{"def":"int(1) DEFAULT 0"},"shared_mysql_server":{"def":"int(1) DEFAULT 0"},"skipbwdata":{"def":"int(1) DEFAULT 0"},"disabled":{"def":"text"},"skiphomedir":{"def":"int(1) DEFAULT 0"},"force":{"def":"int(1) DEFAULT 0"},"replaceip":{"def":"char(255) DEFAULT NULL"},"overwrite_sameowner_dbs":{"def":"int(1) DEFAULT 0"},"skipsubdomains":{"def":"int(1) DEFAULT 0"},"live_transfer":{"def":"int(1) DEFAULT 0"},"domain":{"def":"char(255) DEFAULT NULL"},"ip":{"def":"int(1) DEFAULT 0"},"files":{"def":"BIGINT UNSIGNED DEFAULT 1"},"size":{"def":"BIGINT UNSIGNED DEFAULT 1"},"user":{"def":"char(255) DEFAULT NULL"},"prerequisite_user":{"def":"char(255) DEFAULT NULL"},"reseller":{"def":"int(1) DEFAULT 0"},"cpmovefile":{"def":"text"},"overwrite_all_dbs":{"def":"int(1) DEFAULT 0"},"customip":{"def":"char(255) DEFAULT NULL"},"mail_location":{"def":"char(255) DEFAULT NULL"},"overwrite_all_dbusers":{"def":"int(1) DEFAULT 0"},"skipaccount":{"def":"int(1) DEFAULT 0"},"priority":{"def":"int(1) DEFAULT 255"},"localuser":{"def":"char(255) DEFAULT NULL"},"xferpoint":{"def":"int(1) DEFAULT 0"},"skipres":{"def":"int(1) DEFAULT 0"},"skipemail":{"def":"int(1) DEFAULT 0"},"detected_remote_user":{"def":"char(255) DEFAULT NULL"}}},"required":{"example":["user","localuser"],"description":"A list of schema's required keys.","items":{"type":"string"},"type":"array"},"primary":{"type":"array","description":"The schema's primary key.","items":{"type":"string"},"example":["user"]}}}}}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  transfer_module_schema \\\n  module='AccountRemoteRoot'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/transfer_module_schema?api.version=1&module=AccountRemoteRoot","lang":"HTTP","label":"URL"}],"tags":["Transfers","Transfer Configuration"],"summary":"Return a transfer module's schema","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"description":"Transfers / Transfer Configuration","name":"Transfer Configuration"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"cpsc_set_config":{"tags":[{"name":"cPCloud","description":"cPCloud Service related WHM API 1 functions."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"tags":["cPCloud"],"name":"cPCloud"}],"paths":{"/cpsc_set_config":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{},"description":"A key value object of the updated service configuration."},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"cpsc_set_config","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}}}}}}},"x-cpanel-available-version":"11.112","parameters":[{"description":"The name of the service to update.","schema":{"example":"database","type":"string"},"name":"service","in":"query","required":"true"},{"description":"Service specific configuration parameters.","schema":{"additionalProperties":{"type":"object"},"type":"object","example":"This is an example additional property."},"in":"query","name":"example","required":"false"}],"x-cpanel-internal-only":"true","description":"This function sets the current cPCloud service deployment config.","operationId":"cpsc_set_config","summary":"Set the current deployment configuration for a cPCloud Service.","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cpsc_set_config \\\n  service=database \\\n  instances=3 \\\n  routers=1\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_set_config?api.version=1&service=database&instances=3&routers=2","lang":"HTTP","label":"URL"}],"tags":["cPCloud"]}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.111.0.9999","description":"WHM API."}},"ipv6_range_add":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"name":"IPv6 Address Settings","description":"IP Address Management / IPv6 Address Settings"}],"paths":{"/ipv6_range_add":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"ipv6_range_add","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"11.40","parameters":[{"description":"The IPv6 address range and network portion\nin [CIDR format](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).","schema":{"type":"string","example":"2001:db8:66ac:cafe::/64"},"in":"query","name":"range","required":"true"},{"schema":{"type":"string","example":"ExampleRange"},"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.","required":"true","in":"query","name":"name"},{"required":"false","in":"query","name":"enabled","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"1"},"description":"Whether the IPv6 address range is available.\n\n**Note**\n\n* `1` - Available.\n* `0` - Reserved."},{"name":"note","in":"query","required":"false","description":"A note for the IPv6 address range.","schema":{"type":"string","nullable":"true","example":"Initial IPv6 address pool","default":null}}],"operationId":"ipv6_range_add","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.","summary":"Add IPv6 address range","x-cpanel-api-version":"WHM API 1","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"},{"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","lang":"HTTP","label":"URL"}],"tags":["IP Addresses","IPv6 Address Settings"]}}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv6 Address Settings"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"get_autossl_check_schedule":{"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"paths":{"/get_autossl_check_schedule":{"get":{"description":"This function returns the cron entry for the `autossl_check.pl` AutoSSL certificate check script.","operationId":"get_autossl_check_schedule","parameters":[],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"get_autossl_check_schedule","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"cron":{"type":"array","items":{"type":"string","example":"54 1 * * *"},"description":"A list of the time elements of a cron entry that schedules when the script will run. For more information about each element in a cron entry, read the [Cron Wikipedia article](https://en.wikipedia.org/wiki/Cron)."},"next_time":{"type":"string","example":"2016-06-09T06:00:00.000Z","format":"ISO-8601 Date Time","description":"The next time that the script will run. A time value, in [ISO-8601](http://www.iso.org/iso/home/standards/iso8601.htm) format."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_autossl_check_schedule\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_check_schedule?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return AutoSSL check script cron entry"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"rename_mysql_user":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"MySQL Databases","description":"Databases / MySQL Databases"}],"paths":{"/rename_mysql_user":{"get":{"operationId":"rename_mysql_user","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.","parameters":[{"schema":{"example":"username","type":"string"},"description":"The database user's current name.","required":"true","in":"query","name":"oldname"},{"required":"true","name":"newname","in":"query","schema":{"type":"string","example":"username2"},"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."},{"required":"false","in":"query","name":"cpuser","schema":{"example":"example","format":"username","type":"string"},"description":"The database user's owner."}],"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"rename_mysql_user","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"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"},{"lang":"HTTP","label":"URL","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","summary":"Update MySQL username"}}},"x-tagGroups":[{"name":"Databases","tags":["MySQL Databases"]}]},"get_available_applications":{"x-tagGroups":[{"tags":["Feature Lists"],"name":"Hosting Plans"}],"paths":{"/get_available_applications":{"get":{"parameters":[{"required":"false","in":"query","name":"file","schema":{"type":"string","example":"dynamicui.conf","default":"dynamicui.conf"},"description":"The `dynamicui` configuration file to retrieve, relative to the `/usr/local/cpanel/whostmgr/docroot/themes/x/` directory."},{"schema":{"type":"string","example":"create_support_ticket"},"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.","required":"false","in":"query","name":"applications_list"}],"operationId":"get_available_applications","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.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"groups":{"description":"An array of objects containing the file's contents.","items":{"$ref":"#/components/schemas/Group"}},"raw":{"items":{"$ref":"#/components/schemas/Raw"},"description":"An array of objects containing the file's raw data for template directives.","type":"array"}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"get_available_applications","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"76","tags":["Packages","Feature Lists"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_available_applications\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_applications?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return dynamicui file"}}},"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{"Group":{"description":"A group of features.","type":"object","required":["type","acl","dnsonly_ok","file","group","groupdesc","grouporder"],"properties":{"type":{"type":"string","description":"The object's type.","example":"group"},"groupdesc":{"type":"string","description":"The group's display name.\n\n**Note:**\n\nYou can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation","example":"$LANG{'Group Name'}"},"searchtext":{"type":"string","description":"A list of the group's search terms, space delimited.","example":"search keywords"},"items":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"target":{"type":"string","description":"The area of the interface in which the feature appears.\n\nA valid HTML `<a>` target attribute.","example":"_blank"},"subtype":{"example":"img","enum":["img"],"description":"The icon type to use.\n\n* `img` - The only possible value.","type":"string"},"group":{"example":"group_name","description":"The group name.","type":"string"},"grouporder":{"minimum":"1","type":"integer","example":"1","description":"The group's display order in the WHM interface.\n\n**Note:**\n\nLower values appear at the top of the interface"},"key":{"example":"feature_name","description":"A key to uniquely identify WHM interfaces and their associated assets for the [cPanel Analytics](https://go.cpanel.net/analytics) program.\n\n**Note:**\n\nGenerally, this value matches the `file` parameter's value without the file's extension.","type":"string"},"acl":{"nullable":"true","description":"The group's Access Control Lists (ACLs).\n\n**Note:**\n\n* Only WHM users who possess the specified ACLs can view or use the item.\n* System administrators can configure users' ACLs in WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface (*WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges*).\n* For a complete list of available ACLs, read our [Guide to WHM Plugins - ACL Reference Chart](https://go.cpanel.net/ACLReferenceChart) documentation.","example":"ACL=all","type":"string"},"imgtype":{"type":"string","description":"The group's image type.\n\n* `icon` - The only possible value.","example":"icon","enum":["icon"]},"file":{"type":"string","description":"The icon file to display for the group.\n\n**Note:**\n\n* Icons for any WHM plugins exist separately from the server's theme. For more information, read our [Guide to WHM Plugins - Plugin Files](https://go.cpanel.net/whmpluginfiles) documentation.\n* A valid `.png` or `.svg` image file, relative to the theme's icon directory.","example":"feature_name.png"},"dnsonly_ok":{"enum":["dns"],"example":"dns","description":"The group's status for [cPanel DNSOnly](https://go.cpanel.net/cpanel-dnsonly)™ servers.\n\n* `dns` - The group appears on cPanel DNSOnly servers.\n* `` - The group does not appear on cPanel DNSOnly servers.","nullable":"true","type":"string"}}},"Role":{"description":"The feature's server role.\n\n**Warning:**\n\nThe server creates this parameter automatically. Do **not** edit this parameter's value. We do **not** support customizations to this parameter.\n\n**Note:**\n\n* The icon only appears in the interface if the server configuration uses this role.\n* For more information about roles and server configurations, read our [How to Use Server Profiles](https://go.cpanel.net/howtouseserverprofiles) documentation.","anyOf":[{"properties":{"match":{"type":"string","description":"Whether to require all roles in the roles parameter to match the server's roles.\n\n* `all` - Require the server to match all roles in the roles parameter to display the feature. (AND condition)\n* `any` - Require the server to match any role in the roles parameter to display the feature. (OR condition)","enum":["any"],"example":"any"},"roles":{"example":["MailLocal","MailSend"],"description":"The array of role names.","items":{"type":"string"},"type":"array"}},"type":"object"},{"type":"string","example":"MailSend"}]},"Image":{"required":["type","acl","description","dnsonly_ok","file","group","itemorder","url"],"type":"object","properties":{"acl":{"example":"ACL=all","description":"The feature's Access Control Lists (ACLs).\n\n**Note:**\n\n* Only WHM users who possess the specified ACLs can view or use the item.\n* System administrators can configure users' ACLs in WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface (*WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges*).\n* For a complete list of available ACLs, read our [Guide to WHM Plugins - ACL Reference Chart](https://go.cpanel.net/ACLReferenceChart) documentation.","nullable":"true","type":"string"},"url":{"type":"string","format":"url-path","description":"The feature's interface location. This path is relative to the `/usr/local/cpanel/` directory.","example":"/example_plugin/feature_name"},"file":{"type":"string","description":"The icon file to display for the group.\n\n**Note:**\n\n* Icons for any WHM plugins exist separately from the server's theme. For more information, read our [Guide to WHM Plugins - Plugin Files](https://go.cpanel.net/whmpluginfiles) documentation.\n* A valid `.png` or `.svg` image file, relative to the theme's icon directory.","example":"feature_name.png"},"imgtype":{"type":"string","enum":["icon"],"example":"icon","description":"The feature's image type.\n\n* `icon` - The only possible value."},"dnsonly_ok":{"type":"string","enum":["dns"],"example":"dns","description":"The group's status for [cPanel DNSOnly](https://go.cpanel.net/cpanel-dnsonly)™ servers.\n\n* `dns` - The group appears on cPanel DNSOnly servers.\n* `` - The group does not appear on cPanel DNSOnly servers.","nullable":"true"},"role":{"$ref":"#/components/schemas/Role"},"type":{"type":"string","example":"image","enum":["image"],"description":"The object's type.\n\n* `image` - The only possible value."},"searchtext":{"type":"string","example":"search keywords","description":"A list search terms for the feature, space delimited."},"itemdesc":{"type":"string","description":"The feature's display name.\n\n**Note:**\n\n* You can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation.\n* This should be a [Template Toolkit](https://go.cpanel.net/tmpltoolkit) directive.","example":"$LANG{'Feature Name'}"},"subtype":{"description":"The icon type to use.\n\n* `img` - The only possible value.","example":"img","enum":["img"],"type":"string"},"group":{"type":"string","description":"The group in which the item appears. This is a value of an existing group object.","example":"group_name"},"multiuser_required":{"type":"integer","description":"Whether the server allows for the creation of more than a single user.\n\n* `1` — Display the feature icon.\n* `0` — Do **not** display the feature icon.\n\n**Note:**\n\nYou **cannot** use this parameter on servers with a [cPanel Solo License](https://go.cpanel.net/cpanel-solo-license).","enum":["1"],"example":"1"},"target":{"type":"string","description":"The area of the interface in which the feature appears.\n\nA valid HTML `<a>` target attribute.","example":"_blank"},"minimum_accounts_needed":{"description":"The minimum number of accounts required to display the feature icon.","example":"2","type":"integer","minimum":"1"},"key":{"description":"A key to uniquely identify WHM interfaces and their associated assets for the [cPanel Analytics](https://go.cpanel.net/analytics) program.\n\n**Note:**\n\nGenerally, this value matches the `file` parameter's value without the file's extension.","example":"feature_name","type":"string"},"description":{"type":"string","example":"View and manage reseller accounts on your server. Resellers manage other [asis,cPanel] accounts and can access [asis,cPanel].","description":"The feature's description that displays when the feature appears on the WHM Home interface.\n\n**Note:**\n\nYou can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation."},"subitems":{"type":"array","items":{"$ref":"#/components/schemas/Subitem"}},"service":{"$ref":"#/components/schemas/Service"},"itemorder":{"type":"integer","minimum":"1","description":"The feature's display order within its group.\n\n**Note:**\n\nLower values appear earlier in the group.","example":"1"}},"description":"An individual WHM feature."},"Raw":{"required":["type","itemdesc"],"type":"object","properties":{"type":{"type":"string","enum":["raw"],"example":"raw","description":"The object's type.\n\n* `raw` - The only possible value. Raw data for template directives."},"itemdesc":{"type":"string","description":"A valid [Template Toolkit](https://go.cpanel.net/tmpltoolkit) directive.","example":"[% PROCESS 'menu/plugins_list.tmpl' target='mainFrame' -%]"}},"description":"Raw data for template directives."},"Subitem":{"description":"A subsection of an individual WHM feature.","properties":{"dnsonly_ok":{"description":"The subitem's status for [cPanel DNSOnly](https://go.cpanel.net/cpanel-dnsonly)™ servers.\n\n* `dns` - The subitem appears on cPanel DNSOnly servers.\n* `` - The subitem does not appear on cPanel DNSOnly servers.","enum":["dns"],"example":"dns","nullable":"true","type":"string"},"url":{"description":"The subitem's interface location. This path is relative to the `/usr/local/cpanel/` directory.","format":"url-path","example":"/example_plugin/feature_name","type":"string"},"file":{"type":"string","description":"The icon file to display for the subitem.\n\n**Note:**\n\n* Icons for any WHM plugins exist separately from the server's theme. For more information, read our [Guide to WHM Plugins - Plugin Files](https://go.cpanel.net/whmpluginfiles) documentation.\n* A valid `.png` or `.svg` image file, relative to the theme's icon directory.","example":"feature_name.png"},"acl":{"type":"string","example":"ACL=all","description":"The subitem's Access Control Lists (ACLs).\n\n**Note:**\n\n* Only WHM users who possess the specified ACLs can view or use the item.\n* System administrators can configure users' ACLs in WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface (*WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges*).\n* For a complete list of available ACLs, read our [Guide to WHM Plugins - ACL Reference Chart](https://go.cpanel.net/ACLReferenceChart) documentation.","nullable":"true"},"breadcrumb":{"type":"string","description":"A subitem's parent feature's location.\n\n* The system uses this value to generate breadcrumbs at the top of each WHM interface.\n* The subitem's parent feature's `url` value.","format":"url-path","example":"/example_plugin/feature_name"},"key":{"type":"string","description":"A key to uniquely identify WHM interfaces and their associated assets for the [cPanel Analytics](https://go.cpanel.net/analytics) program.\n\n**Note:**\n\nGenerally, this value matches the `file` parameter's value without the file's extension.","example":"feature_name"},"target":{"type":"string","description":"The area of the interface in which the subitem displays.\n\nA valid HTML `<a>` target attribute.","example":"_blank"},"group":{"type":"string","example":"group_name","description":"The group in which the subitem appears. This is a value of an existing group object."},"parent":{"type":"integer","minimum":"1","description":"The subitem's parent feature's display order in the WHM interface. This is the parent feature's `itemorder` value.","example":"1"},"itemdesc":{"type":"string","description":"The subitem's display name.\n\n**Note:**\n\n* You can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation.","example":"$LANG{'Feature Name'}"},"searchtext":{"type":"string","example":"search keywords","description":"A list search terms for the subitem, space delimited."},"type":{"enum":["subitem"],"example":"subitem","description":"The object's type.\n\n* `subitem` - The only possible value.","type":"string"}},"type":"object","required":["type","acl","breadcrumb","dnsonly_ok","file","group","parent","url"]},"Service":{"oneOf":[{"type":"object","properties":{"services":{"example":["mysql","ftp"],"description":"An array of services.","items":{"type":"string"},"type":"array"},"match":{"type":"string","description":"Whether to require all services in the services parameter to match enabled services on the server.\n\n* `all` - Require the server to match **all** services under the `services` key to display the feature. (AND condition)\n* `any` - Require the server to match any service under the `services` key to display the feature. (OR condition)","enum":["any"],"example":"any"}}},{"type":"string","example":"mysql"}],"description":"The [cPanel Service Daemon](https://go.cpanel.net/ThecPanelWHMServiceDaemons) that monitors the feature.\n\n**Warning:**\n\nThe server creates this parameter automatically. Do **not** edit this parameter's value. We do not support customizations to this parameter.\n\n**Note:**\n\n* This icon only appears on servers with the service enabled.\n* For a complete list of service daemons, read our [cPanel Service Daemons](https://go.cpanel.net/ThecPanelWHMServiceDaemons) documentation.","example":"mysql"}},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"expunge_messages_for_mailbox_guid":{"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"paths":{"/expunge_messages_for_mailbox_guid":{"get":{"parameters":[{"schema":{"type":"string","example":"user@example.com"},"description":"The email account's name.","required":"true","in":"query","name":"account"},{"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.","schema":{"type":"string","example":"2550860f0c58d158c92a000044f0d230"},"in":"query","name":"mailbox_guid","required":"true"},{"in":"query","name":"query","required":"true","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.","schema":{"type":"string","example":"savedbefore 52w"}}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"expunge_messages_for_mailbox_guid","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"64","x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Remove email account messages by mailbox GUID","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2"},"cpgreylist_list_entries_for_common_mail_provider":{"paths":{"/cpgreylist_list_entries_for_common_mail_provider":{"get":{"tags":["Greylisting","Spam Protection (Greylisting)"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_list_entries_for_common_mail_provider \\\n  provider='cpanel'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_list_entries_for_common_mail_provider?api.version=1&provider=cpanel"}],"x-cpanel-api-version":"WHM API 1","summary":"Return Greylisting IP addresses of mail providers","parameters":[{"required":"true","name":"provider","in":"query","schema":{"type":"string"},"description":"The mail provider.\n\n**Note:**\n\n * To list entries for multiple mail providers, increment the parameter name. For example, `provider-0`, `provider-1`, and `provider-2`.\n * Call WHM API 1's `cpgreylist_load_common_mail_providers_config` function to return a list of valid provider keys.","examples":{"single":{"summary":"List a single mail provider entry.","value":"cpanel"},"multiple":{"value":"provider-0=example-0 provider-1=example-1 provider-2=example-2","summary":"List multiple mail provider entries."}}}],"operationId":"cpgreylist_list_entries_for_common_mail_provider","description":"This function lists Greylisting's IP addresses for the specified mail provider.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"providers_failed":{"additionalProperties":{"type":"string","description":"The reason why the system failed to list IP addresses for the provider.\n\n**Note:**\n\nThe return's name is the mail provider's display name."},"type":"object","description":"An object containing mail providers that the system failed to retrieve data for."},"providers":{"additionalProperties":{"description":"An object containing an object that contains the mail provider's IP address data.\n\n**Note:**\n\nThe return's name is the mail provider's display name.","type":"object","properties":{"ips":{"description":"An object containing the mail provider's IP address data.","properties":{"create_time":{"description":"The date and time when the function created the record.","format":"ISO-8601 Date Time (Space Separated)","example":"2015-07-28T08:16:52.000Z","type":"string"},"is_trusted":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether Greylisting trusts this mail provider's IP addresses.\n- `1` — Trusted.\n- `0` — Not trusted."},"provider_id":{"minimum":"1","type":"integer","description":"The mail provider's identification number.","example":"7"},"host_ip":{"type":"string","example":"192.168.0.1","format":"ipv4","description":"The mail provider's IP address or range."}}}}},"description":"An object containing mail providers and their IP addresses."}},"type":"object","example":{"providers_failed":{"dpanel":"Unknown mail provider: dpanel"},"providers":{"cpanel":{"ips":[{"host_ip":"208.115.214.0-208.115.214.255","is_trusted":"1","provider_id":"7","create_time":"2015-07-28T08:16:52"},{"create_time":"2015-07-28T08:16:52","host_ip":"74.63.202.0-74.63.202.255","provider_id":"7","is_trusted":"1"}]}}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"cpgreylist_list_entries_for_common_mail_provider","description":"The method name called.","type":"string"}}}}}}}}},"x-cpanel-available-version":"11.52"}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Protection (Greylisting)"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Greylisting","description":"The Greylisting module for WHM API 1."},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"flush_cphulk_login_history_for_ips":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Management"],"name":"Login Security (cPHulk)"}],"paths":{"/flush_cphulk_login_history_for_ips":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  flush_cphulk_login_history_for_ips \\\n  ip='192.168.0.1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/flush_cphulk_login_history_for_ips?api.version=1&ip=192.168.0.1","lang":"HTTP","label":"URL"}],"tags":["cPHulk","Management"],"summary":"Remove login security IP address block","x-cpanel-api-version":"WHM API 1","parameters":[{"schema":{"type":"array","items":{"anyOf":[{"type":"string","format":"ipv4"},{"format":"ipv6","type":"string"}]}},"explode":"true","examples":{"single":{"value":["192.168.0.1"],"description":"A single IPv4 address."},"multiple":{"description":"Multiple IPv4 addresses.","value":["192.168.0.1","192.168.0.2","192.168.0.3"]},"single-ipv6":{"value":["2001:db8::1"],"summary":"Single IPv6 Address"},"multiple-ipv6":{"value":["2001:db8::1","2002:db8::1","2003:db8::1"],"summary":"Multiple IPv6 addresses."}},"required":"true","name":"ip","in":"query","style":"form","description":"The record's IP address.\n\n**Note:**\n\n To unblock multiple IP addresses, increment the parameter name (for example, to unblock three IP addresses, use the `ip-1`, `ip-2`, and `ip-3` parameters)."}],"operationId":"flush_cphulk_login_history_for_ips","description":"This function removes specific login history entries from the cPHulk database. Use this function to unblock one or more IP addresses.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"flush_cphulk_login_history_for_ips","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"iptable_bans_removed":{"minimum":"0","type":"integer","example":"1","description":"The number of `iptables` temporary block rules that the function deleted."},"records_removed":{"type":"integer","minimum":"0","description":"The number of entries that the function deleted.","example":"1"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.50"}}},"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Management","name":"Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}]},"set_service_config_key":{"paths":{"/set_service_config_key":{"get":{"summary":"Update service configuration key","x-cpanel-api-version":"WHM API 1","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"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_service_config_key?api.version=1&service=dovecot&key=mail_process_size&value=512"}],"tags":["Server Administration","Services"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"Succeeded","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"set_service_config_key","description":"The method name called.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"58","parameters":[{"required":"true","in":"query","name":"service","schema":{"type":"string","example":"dovecot"},"description":"The service's name.\n\n* A list of service names exists in the `/var/cpanel/conf` directory."},{"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.","schema":{"example":"mail_process_size","type":"string"},"name":"key","in":"query","required":"true"},{"description":"The new value for the configuration key.","schema":{"example":"512","oneOf":[{"type":"string"},{"type":"integer"}]},"name":"value","in":"query","required":"true"}],"operationId":"set_service_config_key","description":"This function configures global properties for specific services listed in the `/var/cpanel/conf` directory."}}},"x-tagGroups":[{"name":"Server Administration","tags":["Services"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Services","description":"Server Administration / Services"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"block_incoming_email_from_domain":{"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Spam Management","description":"Mail / Spam Management"}],"paths":{"/block_incoming_email_from_domain":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Mail","Spam Management"],"summary":"Add block on emails from specific domains","x-cpanel-api-version":"WHM API 1","operationId":"block_incoming_email_from_domain","description":"This function blocks email from specific domains.","parameters":[{"examples":{"multiple-alternative":{"summary":"Multiple domains.","value":"domain=example.com domain=example1.com domain=example2.com"},"multiple":{"value":"domain=example.com domain-1=example1.com domain-2=example2.com","summary":"Multiple domains."},"single":{"value":"example.com","summary":"A single domain."}},"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.","schema":{"type":"string"},"in":"query","name":"domain","required":"true"}],"x-cpanel-available-version":"84","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"updated":{"enum":["0","1"],"example":"1","description":"Whether the function blocked one or more domains.\n* 1 — Success.\n* 0 — Failure.","type":"integer"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"block_incoming_email_from_domain","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}}}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Management"]}]},"backup_list_transported":{"tags":[{"description":"The Backups module for WHM API 1.","name":"Backups"},{"description":"Backups / Backup or Restore","name":"Backup or Restore"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Backup or Restore"],"name":"Backups"}],"paths":{"/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.","schema":{"type":"string","example":"nN04BhzirlJUNSLSBXSMBEYG"},"in":"query","name":"transport","required":"false"}],"x-cpanel-available-version":"76","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"type":"string","description":"The method name called.","example":"backup_list_transported"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"remote_backups":{"additionalProperties":{"type":"object","additionalProperties":{"type":"array","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":"","format":"ISO-8601 Date","example":"2018-07-19T00:00:00.000Z","type":"string"}},"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"}}}}}}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_list_transported\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_list_transported?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Backups","Backup or Restore"],"summary":"Return backup files sent through transport","x-cpanel-api-version":"WHM API 1"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}}},"fetch_mail_queue":{"x-tagGroups":[{"name":"Mail","tags":["Mail Server Settings"]}],"paths":{"/fetch_mail_queue":{"get":{"parameters":[],"description":"This function retrieves the contents of the server's mail queue.","operationId":"fetch_mail_queue","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"fetch_mail_queue"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}},"data":{"type":"object","properties":{"records":{"type":"array","description":"An array of objects that contain of the message information.","items":{"type":"object","properties":{"user":{"nullable":"true","description":"The mail message's owner.","example":null,"type":"string"},"recipients":{"items":{"type":"string","example":"pricilla@graceland.com","format":"email"},"description":"An array of the mail message's recipients.","type":"array"},"size":{"minimum":"0","type":"integer","example":"14336","format":"bytes","description":"The mail message's size in bytes."},"time":{"example":"1371552781","description":"The mail message's timestamp.","format":"unix_timestamp","type":"integer"},"msgid":{"description":"The mail message's ID.","example":"1UotX3-0002HX-Lr","type":"string"},"frozen":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the mail message is frozen.\n* `1` — Frozen.\n* `0` — **Not** frozen."},"sender":{"type":"string","example":"elvis@graceland.com","format":"email","description":"The mail message's sender."}}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  fetch_mail_queue\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_mail_queue?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Mail","Mail Server Settings"],"summary":"Return server mail queue contents","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"fetch_ds_records_for_domains":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"paths":{"/fetch_ds_records_for_domains":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"fetch_ds_records_for_domains"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}},"data":{"type":"object","properties":{"domains":{"type":"array","description":"An array of objects that contains information about each domain.","items":{"type":"object","properties":{"ds_records":{"type":"object","properties":{"nsec_details":{"type":"object","properties":{"nsec_version":{"type":"string","example":"NSEC3","enum":["NSEC","NSEC3"],"description":"Whether the domain uses NSEC or NSEC3 ([Next Secure Record version 3](https://tools.ietf.org/html/rfc5155)) DNSSEC semantics."},"nsec3_hash_algo_num":{"type":"integer","minimum":"1","description":"The DNSSEC ([Domain Name Security Extensions](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions)) Digest Algorithm Number.","example":"1"},"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"},"nsec3_iterations":{"description":"The number of times that the system rehashes the first hash operation.","example":"7","minimum":"1","type":"integer"},"nsec3_hash_algo_desc":{"description":"description of the NSEC3 key's algorithm.","example":"SHA-1","type":"string"},"nsec3_narrow":{"enum":["0","1"],"example":"1","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.","type":"integer"},"nsec3_opt_out":{"type":"integer","example":"0","enum":["0","1"],"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."}},"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."},"keys":{"description":"An object containing the DS keys on the requested domain.","type":"object","additionalProperties":{"type":"object","properties":{"algo_tag":{"description":"The short-form reference to the algorithm.","example":"RSASHA256","type":"string"},"key_tag":{"type":"integer","minimum":"1","description":"The DS key's integer value.","example":"40481"},"algo_desc":{"type":"string","example":"RSA/SHA-256","description":"A description of the algorithm that the DS key uses."},"key_id":{"minimum":"1","type":"integer","description":"PowerDNS's internal identifier.","example":"1"},"key_type":{"example":"KSK","enum":["CSK","KSK","ZSK"],"description":"The DS key's signing type.\n* `CSK` - Combined Signing Key.\n* `KSK` - Key Signing Key.\n* `ZSK` - Zone Signing Key.","type":"string"},"algo_num":{"type":"integer","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","example":"8","enum":["5","6","7","8","10","13","14"]},"bits":{"description":"The DS key's size, in bits.","format":"bits","example":"2048","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.","format":"unix_timestamp","example":"1575395316","type":"integer"},"privatekey":{"type":"string","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"},"active":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether the DS key is active.\n* `1` - Active.\n* `0` - Inactive."},"flags":{"type":"integer","example":"257","enum":["256","257"],"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)."},"digests":{"type":"array","items":{"properties":{"algo_num":{"example":"1","description":"The IETF-recognized DNSSEC Algorithm Number.","minimum":"1","type":"integer"},"digest":{"example":"2808a14b89118256119d93d24b9e6b673dca092b","description":"The actual digest in the DS record.","type":"string"},"algo_desc":{"type":"string","example":"SHA-1","description":"A description of the algorithm that the DS record uses."}},"type":"object"},"description":"An array of objects of information the registrar uses to populate DS records."}},"description":"Each key/value property includes information related the domain's DNSSEC record."}}},"example":{"nsec_details":{"nsec3_iterations":"7","nsec3_hash_algo_desc":"SHA-1","nsec3_narrow":"1","nsec3_hash_algo_num":"1","nsec_version":"NSEC3","nsec3_salt":"1a2b3c4d5e6f","nsec3_opt_out":"0"},"keys":{"40481":{"created":"1575395316","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","active":"1","flags":"257","digests":[{"algo_num":"1","digest":"2808a14b89118256119d93d24b9e6b673dca092b","algo_desc":"SHA-1"},{"digest":"02a57812deb952438382ed8dd20f00d4af844a55b5324d28bb","algo_num":"2","algo_desc":"SHA-256"},{"algo_desc":"SHA-384","algo_num":"4","digest":"4569a6fcfe9e151ec6a163307e67eaa3a9547f16cd80751b0d46eb498bd96743bd4ff7c4f6fd5f76cc780aeb979cd08d"}],"algo_num":"8","bits":"2048","algo_desc":"RSA/SHA-256","key_id":"1","key_type":"KSK","algo_tag":"RSASHA256","key_tag":"40481"}}},"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."},"domain":{"type":"string","example":"example.com","format":"domain","description":"The domain name."}}}}}}},"type":"object"}}}}},"x-cpanel-available-version":"86","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":{"value":"domain=example.com&domain=example1.com&domain=example2.com","summary":"Multiple domains"},"single":{"value":"example.com","summary":"A single domain."}},"schema":{"type":"string","format":"domain","example":"example.com"},"in":"query","name":"domain","required":"true"}],"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","summary":"Return domain's DS record","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  fetch_ds_records_for_domains \\\n  domain='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_ds_records_for_domains?api.version=1&domain=example.com","lang":"HTTP","label":"URL"}],"tags":["DNS","Domain Management"]}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"Domain Management","description":"DNS / Domain Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}]},"send_test_posturl":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Notifications","name":"Notifications"}],"paths":{"/send_test_posturl":{"get":{"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"},{"lang":"HTTP","label":"URL","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"}],"tags":["Server Administration","Notifications"],"summary":"Send notification URL via POST","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","in":"query","name":"url","schema":{"example":"https%3A%2F%2Fwww.example.com%2Fevents.cgi%3Fapikey%3D12345%26user%3Dusername*password%3D12345luggage","type":"string"},"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."}],"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","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message_id":{"type":"string","description":"The test message's ID.","example":"554d2cbd-efe61da3cacb"}}},"metadata":{"properties":{"command":{"type":"string","example":"send_test_posturl","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52"}}},"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"retrieve_transfer_session_remote_analysis":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"name":"Transfer Monitoring","description":"Transfers / Transfer Monitoring"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Transfer Monitoring"],"name":"Transfers"}],"paths":{"/retrieve_transfer_session_remote_analysis":{"get":{"parameters":[{"in":"query","name":"transfer_session_id","required":"true","description":"The transfer session's ID.","schema":{"example":"exampleservercopya20140206192428NtyW","type":"string"}}],"description":"This function analyzes a transfer session.\n\n**Note:**\n\n  For more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","operationId":"retrieve_transfer_session_remote_analysis","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"retrieve_transfer_session_remote_analysis","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"items":{"description":"An object containing items to transfer.","type":"object","properties":{"accounts":{"description":"The accounts to transfer.","type":"array","additionalProperties":{"type":"string","description":"Information for each account."}},"packages":{"description":"The packages to transfer.","additionalProperties":{"type":"string","description":"List of packages and featurelists."},"type":"array"}}},"transfer_session_id":{"description":"The transfer session's ID.","example":"exampleservercopya20140206192428NtyW","type":"string"},"options":{"properties":{"skip_reseller_privs":{"type":"integer","enum":["0","1"],"default":"0","description":"Whether reseller privileges will be set to transfer by default.\n* `0` - Reseller privileges will **not** be set to transfer by default.\n* `1` - Reseller privileges will be set to transfer by default."},"unrestricted":{"type":"integer","description":"Whether the transfer session will use [Restriced Restore](https://go.cpanel.net/insecurerestoreaccount).\n* `0` - Transfer session will use Restriced Restore.\n* `1` _ Transfer session will **not** use Restirced Restore.","default":"1","enum":["0","1"]}},"type":"object","description":"An object containing transfer session options."},"local":{"type":"object","properties":{"version":{"example":"11.90.0.6","format":"cPanel version","description":"The local server's version of cPanel.","type":"string"},"domains":{"example":{"*":"nobody","domain.tld":"user"},"description":"A list of the local server's domains and owners."},"available_ips":{"items":{"example":"192.168.1.1","oneOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"description":"A list of the local server's available IP addresses.","type":"array"},"users":{"description":"An object containing the local server's account users.","example":{"root":"1","nobody":"1"},"type":"object","additionalProperties":{"enum":["1"],"description":"The user's name is the key's name. Value is **always** `1`.","type":"integer"}},"roundcube_dbtype":{"type":"string","description":"The database type Roundcube uses on the local server.","enum":["sqlite","mysql"],"example":"sqlite"},"groups":{"description":"An object containing the local server's account groups.","example":{"bin":"1","nobody":"1"},"type":"object","additionalProperties":{"type":"integer","description":"The group name is the key's name. Value is **always** `1`.","enum":["1"]}},"dbs":{"properties":{"dbs":{"description":"An object containing the local server's databases.","properties":{"PGSQL":{"type":"object","additionalProperties":{"properties":{"owner":{"description":"Owner of the database.","type":"string"}},"type":"object","description":"An object containing the database owner.\n\n**Note:**\n\n  The database's name is the key's name."},"example":{"user_db1":{"owner":"user"},"user_db2":{"owner":"user"}},"description":"An object containing the local server's PgSQL databases."},"MYSQL":{"type":"object","additionalProperties":{"properties":{"owner":{"type":"string","description":"Owner of the database."}},"type":"object","description":"An object containing the database owner.\n\n**Note:**\n\n  The database's name is the key's name."},"example":{"user_db1":{"owner":"user"},"user_db2":{"owner":"user"}},"description":"An object containing the local server's MySQL databases."}},"type":"object"},"users":{"properties":{"MYSQL":{"description":"An object containing the local server's MySQL users.","example":{"user_user1":{"owner":"user"},"user_user2":{"owner":"user"}},"additionalProperties":{"description":"An object containing the database user owner.\n\n**Note:**\n\n  The database user's name is the key's name.","type":"object","properties":{"owner":{"type":"string","description":"Owner of the database user."}}},"type":"object"},"PGSQL":{"description":"An object containing the local server's PgSQL databases users.","example":{"user_user2":{"owner":"user"},"user_user1":{"owner":"user"}},"type":"object","additionalProperties":{"properties":{"owner":{"description":"Owner of the user.","type":"string"}},"type":"object","description":"An object containing the database user owner.\n\n**Note:**\n\n  The database user's name is the key's name."}}},"type":"object","description":"An object containing the local server's database users."}},"type":"object","description":"An object containing the local server's databases and users."},"major_version":{"type":"string","description":"The local server's major version.","example":"11.90"},"dedicated_ips":{"description":"A list of the local server's dedicated IP addresses.","example":{"192.168.1.2":"domain.tld"},"type":"object","additionalProperties":{"description":"Domain with a dedicated IP address. The dedicated IP addresses is the key's name.","type":"string"}},"host":{"type":"string","example":"hostname.domain.tld","description":"The local server's hostname.","format":"domain"}},"description":"An object containing the local server's information."},"modules":{"example":{"Backups":{"name":"Backups","analysis":{"Local Backups Version":"11.90.0.6","Remote Backups Version":"11.88.0.7"}},"MySQL":{"name":"Database Server","analysis":{"Remote Version":"10.3","Local Type":"MySQL","Remote Type":"MariaDB","Local Version":"5.7"}}},"description":"An list of objects containing the module infromation of both servers.","type":"object","additionalProperties":{"description":"An object containing the module.\n\n**Note:**\n\n  The module name is the key's name.","type":"object","properties":{"name":{"type":"string","description":"The name of the module."},"analysis":{"description":"Module information from both servers.","type":"object","additionalProperties":{"description":"Module version and other information when applicable. Key name will be either `Local` or `Remote`, followed by the module information type.","type":"string"}}}}},"config":{"properties":{"shared_mysql_server":{"description":"Whether the remote and target server share the same MySQL® server.\n* `1` - The remote and target server share the same MySQL server.\n* `0` - The remote and target server do **not** share the same MySQL server.","example":"1","enum":["0","1"],"type":"integer"}},"type":"object","description":"An object containing the transfer configuration options."},"remote":{"description":"An object containing the remote server's information.","properties":{"server_type":{"description":"The remote server's type.\n* An internal cPanel type ID dependent on cPanel version.\n* `Plesk`\n* `Ensim`","example":"WHM1164","type":"string"},"hostname":{"format":"domain","description":"The local server's hostname.","example":"hostname.domain.tld","type":"string"},"resellers":{"additionalProperties":{"description":"The reseller's username is the key's name. Value is **always** `1`.","enum":["1"],"type":"integer"},"type":"object","example":{"resell2":"1","root":"1","reseller":"1"},"description":"The remote servers reseller accounts that own one or more accounts.\n\n**Note:**\n\n  This won't return a value if the `root` user is the only user that owns accounts."},"has_owners":{"type":"integer","description":"Whether the remote server can transmit owner information to the target server.\n* `1` — Remote server can transmit owner information.\n* `0` — Remote server **cannot** transfer owner information, and the transfer tool will assume that root owns all accounts.","enum":["0","1"],"example":"1"},"conflicts":{"type":"object","description":"Remote server data load error message."},"roundcube_dbtype":{"description":"The database type Roundcube uses on the remote server.","enum":["sqlite","mysql"],"example":"sqlite","type":"string"},"version":{"type":"string","format":"cPanel version","description":"The remote server's software version number.","example":"11.90.0.6"},"has_files_used":{"enum":["0","1"],"example":"1","description":"Whether the remote server can transmit file usage information to the target server.\n* `1` - Remote server can transmit file usage information.\n* `0` - Remote server **cannot** transmit file usage information.\n\n**Note:**\n\n  cPanel & WHM servers have this ability by default.","type":"integer"},"host":{"type":"string","example":"192.168.1.1","format":"ipv4","description":"The remote server's IP address."},"major_version":{"type":"string","example":"11.90","description":"The remote server's major version."},"supports_live_transfers":{"type":"integer","description":"Whether the remote server supports the Live Transfers feature in WHM's Transfer Tool  interface (WHM >> Home >> Transfers >> Transfer Tool).\n* `1` — Supported.\n* `0` — **Not** supported.","example":"1","enum":["0","1"]},"has_xfertool":{"type":"integer","description":"Whether the remote server has the transfer tool.\n* `1` - Remote server has the transfer tool.\n* `0` - Remote server does **not** have the transfer tool.","enum":["0","1"],"example":"1"},"has_disk_used":{"description":"Whether the remote server can transmit disk usage information to the target server.\n* `1` - Remote server can transmit disk usage information.\n* `0` - Remote server **cannot** transmit disk usage information.\n\n**Note:**\n\n  cPanel & WHM servers have this ability by default.","enum":["0","1"],"example":"1","type":"integer"},"linked_nodes":{"type":"array","items":{"type":"object","properties":{"hostname":{"description":"The remote server's linked cPanel server node hostname.","format":"domain","example":"remotemailnode.example.com","type":"string"},"last_check":{"type":"integer","description":"Last time linked node was checked.","format":"unix_timestamp","example":"1600126907"},"tls_verified":{"type":"integer","description":"Whether the connection to the server node is using TLS verification.\n* `0` - Server node connection is **note** using TLS verification.\n* `1` - Server node connection is using TLS verification.","enum":["0","1"],"example":"1"},"username":{"type":"string","description":"The username the server node link uses.","example":"root"},"system_settings":{"description":"An object containing server role system settings.","example":{"Mail":{"globalspamassassin":"0"}},"additionalProperties":{"description":"An object containing the server role.\n\n**Note:**\n\n  The server role's name is the key's name.","additionalProperties":{"type":"integer","enum":["0","1"],"description":"Server role system setting.\n* `0` - System setting is **not** enabled.\n* `1` - System setting is enabled.\n\n**Note:**\n\n  The system setting's name is the key's name."},"type":"object"},"type":"object"},"alias":{"type":"string","example":"mailnode","description":"The remote server's linked cPanel server node alias."},"worker_capabilities":{"example":{"Mail":{}},"description":"An object containing a group of services required for the remote server's linked cPanel server node to perform a specific task.","type":"object","additionalProperties":{"type":"object","description":"An object containing the server role.\n\n**Note:**\n\n  The server role's name is the key's name."}},"enabled_services":{"example":["exim","imap"],"description":"Enabled services on the linked node.","items":{"type":"string"},"type":"array"},"version":{"type":"string","example":"11.90.0.6","description":"The server node's software version number.","format":"cPanel version"}}},"description":"An array containing the remote server's linked cPanel server nodes, if any exist."},"has_package_extensions":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the remote server has package extensions.\n* `1` - Remote server has package extensions.\n* `0` - Remote server does **not** have package extensions."},"cpversion":{"type":"string","example":"11.64","description":"Remote server internal version."},"dbs":{"description":"An object containing the remote server's databases and users.","properties":{"dbs":{"type":"object","properties":{"PGSQL":{"description":"An object containing the remote server's PgSQL databases.","example":{"user_db1":{"owner":"user"},"user_db2":{"owner":"user"}},"additionalProperties":{"type":"object","properties":{"owner":{"description":"Owner of the database.","type":"string"}},"description":"An object containing the database owner.\n\n**Note:**\n\n  The database's name is the key's name."},"type":"object"},"MYSQL":{"description":"An object containing the remote server's MySQL databases.","example":{"user_db2":{"owner":"user"},"user_db1":{"owner":"user"}},"type":"object","additionalProperties":{"description":"An object containing the database owner.\n\n**Note:**\n\n  The database's name is the key's name.","properties":{"owner":{"type":"string","description":"Owner of the database."}},"type":"object"}}},"description":"An object containing the remote server's databases."},"users":{"type":"object","properties":{"MYSQL":{"example":{"user_user2":{"owner":"user"},"user_user1":{"owner":"user"}},"description":"An object containing the remote server's MySQL users.","additionalProperties":{"description":"An object containing the database user owner.\n\n**Note:**\n\n  The database user's name is the key's name.","type":"object","properties":{"owner":{"type":"string","description":"Owner of the database user."}}},"type":"object"},"PGSQL":{"example":{"user_user2":{"owner":"user"},"user_user1":{"owner":"user"}},"description":"An object containing the remote server's PgSQL databases users.","additionalProperties":{"properties":{"owner":{"description":"Owner of the user.","type":"string"}},"type":"object","description":"An object containing the database user owner.\n\n**Note:**\n\n  The database user's name is the key's name."},"type":"object"}},"description":"An object containing the remote server's database users."}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  retrieve_transfer_session_remote_analysis \\\n  transfer_session_id='exampleservercopya20140206192428NtyW'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/retrieve_transfer_session_remote_analysis?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW","label":"URL","lang":"HTTP"}],"tags":["Transfers","Transfer Monitoring"],"summary":"Return transfer session's information","x-cpanel-api-version":"WHM API 1"}}}},"backup_date_list":{"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Backups module for WHM API 1.","name":"Backups"},{"name":"Backup Settings","description":"Backups / Backup Settings"}],"paths":{"/backup_date_list":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"backup_set":{"type":"array","example":["2019-02-12T00:00:00.000Z","2019-02-12T00:00:00.000Z","2019-02-12T00:00:00.000Z"],"items":{"type":"string","format":"ISO-8601 Date"},"description":"A list of dates containing the backup files."}}},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"backup_date_list","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"backup_date_list","description":"This function lists the dates where backup file exists, whether stored locally or stored on remote backup destinations when local backups are disabled.","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return dates where backup files exist","tags":["Backups","Backup Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  backup_date_list\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_date_list?api.version=1","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"name":"Backups","tags":["Backup Settings"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"enable_market_provider":{"x-tagGroups":[{"tags":["Provider Management"],"name":"cPanel Market"}],"paths":{"/enable_market_provider":{"get":{"x-cpanel-available-version":"56","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","example":"enable_market_provider","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"enable_market_provider","description":"This function enables a cPanel Market provider.","parameters":[{"schema":{"type":"string","example":"cPStore"},"description":"The cPanel Market provider's name.","required":"true","name":"name","in":"query"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable Market provider","tags":["Market","Provider Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enable_market_provider \\\n  name='cPStore'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_market_provider?api.version=1&name=cPStore","label":"URL","lang":"HTTP"}]}}},"tags":[{"description":"The Market module for WHM API 1.","name":"Market"},{"description":"cPanel Market / Provider Management","name":"Provider Management"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"editpkg":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Hosting Plans","description":"Hosting Plans / Hosting Plans"}],"paths":{"/editpkg":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"pkg":{"description":"The new hosting plan's name.","example":"package1","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"example":"editpkg","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function edits a hosting plan (package).\n\n**Note:**\n\n* The\n[Access Control List (ACL)](https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists)\nrestricts some of the function's parameters, which limit the features that WHM\nusers can access.\n* This function applies any changes you make to **all** accounts that exist on\nthe hosting plan.\n* This function **cannot** modify hosting plan names.","operationId":"editpkg","parameters":[{"required":"true","name":"name","in":"query","schema":{"type":"string","example":"package1"},"description":"The hosting plan's name. If the hosting plan does not exist, the system will create it."},{"name":"featurelist","in":"query","required":"false","description":"The hosting plan's feature list.\n\nIf you do **not** use this parameter, the function assigns the `default`\nfeature list to the hosting plan's accounts.","schema":{"default":"default","example":"default","type":"string"}},{"required":"false","name":"quota","in":"query","schema":{"default":"10240","example":"10240","oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}]},"description":"The hosting plan's disk space quota, in megabytes (MB).\n\n* `0`, `unlimited`, or `null` — The hosting plan allows unlimited\ndisk space quota.\n\n**Note:**\n\nThe `0`, `unlimited`, or `null` values are **only** available to\nusers that possess the corresponding `unlimited` ACL permission."},{"schema":{"type":"string","example":"n","enum":["y","n"],"default":"n"},"description":"Whether the hosting plan uses a dedicated IP address.\n\n* `y` — The hosting plan uses a dedicated IP address.\n* `n` — The hosting plan does **not** use a dedicated IP address.","required":"false","in":"query","name":"ip"},{"in":"query","name":"cgi","required":"false","description":"Whether CGI access is enabled for the hosting plan.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nWhen a [server profile](https://go.cpanel.net/whmdocsServerProfile) disables\nthe [Web Server role](https://go.cpanel.net/serverroles#roles), this parameter\ndefaults to `0`. On these servers, you **cannot** enable CGI access.","schema":{"enum":["1","0"],"example":"1","default":"1","type":"integer"}},{"deprecated":"true","schema":{"default":"0","enum":["1","0"],"example":"0","type":"integer"},"description":"Whether Microsoft® FrontPage Extensions are enabled for the account.\n\n**Note:**\n\ncPanel & WHM ignores all FrontPage settings and parameters.","in":"query","name":"frontpage","required":"false"},{"name":"cpmod","in":"query","required":"false","description":"The hosting plan's cPanel theme.\n\nThis parameter defaults to the server's\n[default cPanel theme](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup).","schema":{"type":"string","example":"jupiter"}},{"name":"language","in":"query","required":"false","description":"The hosting plan's default locale.\n\nThis parameter defaults to the server's default locale.","schema":{"type":"string","example":"en","format":"ISO-3166-1 (alpha-2)"}},{"required":"false","in":"query","name":"max_emailacct_quota","schema":{"oneOf":[{"maximum":"4294967296","type":"integer","minimum":"0"},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"example":"1024","default":"1024"},"description":"The hosting plan's maximum email account quota size, in megabytes (MB).\n\n* `0`, `null, or `unlimited` — The hosting plan allows unlimited quota.\n\n**Note:**\n\n* This parameter does **not** affect any existing email accounts.\n* The `unlimited` value is **only** available to users that possess\nthe corresponding `unlimited` ACL permission."},{"name":"maxftp","in":"query","required":"false","description":"The hosting plan's maximum number of FTP accounts.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited databases.","schema":{"default":"unlimited","example":"unlimited","oneOf":[{"minimum":"0","type":"integer","maximum":"999999"},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}]}},{"name":"maxsql","in":"query","required":"false","description":"The hosting plan's maximum number of each available type of SQL\ndatabase.\n\nFor example, if you set this value to `5` and the system administrator\nallows MySQL® and PostgreSQL® databases, users with this hosting plan\ncan create up to five MySQL databases and up to five PostgreSQL databases.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited\ndatabases.","schema":{"oneOf":[{"type":"integer","maximum":"999999","minimum":"0"},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"example":"unlimited","default":"unlimited"}},{"description":"The hosting plan's maximum number of email accounts.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited\nemail accounts.","schema":{"oneOf":[{"minimum":"0","maximum":"999999","type":"integer"},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"default":"unlimited","example":"unlimited"},"in":"query","name":"maxpop","required":"false"},{"required":"false","in":"query","name":"maxlst","schema":{"oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"default":"unlimited","example":"unlimited"},"description":"The hosting plan's maximum number of mailing lists.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited\nmailing lists."},{"required":"false","in":"query","name":"maxsub","schema":{"oneOf":[{"minimum":"0","maximum":"999999","type":"integer"},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"default":"unlimited","example":"unlimited"},"description":"The hosting plan's maximum number of subdomains.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited\nsubdomains."},{"in":"query","name":"maxpark","required":"false","description":"The hosting plan's maximum number of parked domains (aliases).\n\n* `unlimited` or `null` — The hosting plan allows unlimited parked\ndomains.","schema":{"oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"example":"unlimited","default":"0"}},{"description":"The hosting plan's maximum number of addon domains.\n\n* `unlimited` or `null` — The hosting plan allows unlimited\naddon domains.","schema":{"default":"0","example":"unlimited","oneOf":[{"minimum":"0","type":"integer","maximum":"999999"},{"enum":["null"]},{"type":"string","enum":["unlimited"]}]},"in":"query","name":"maxaddon","required":"false"},{"required":"false","name":"max_team_users","in":"query","schema":{"nullable":"true","example":"7","type":"integer","maximum":"7","minimum":"0"},"description":"The hosting plan's maximum number of Team users."},{"description":"Whether the hosting plan allows shell access.\n\n* `1` — The hosting plan allows shell access.\n* `0` — The hosting plan does **not** allow shell access.","schema":{"type":"integer","default":"0","example":"1","enum":["1","0"]},"name":"hasshell","in":"query","required":"false"},{"schema":{"oneOf":[{"minimum":"0","type":"integer","maximum":"999999"},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"example":"1048576","default":"1048576"},"description":"The hosting plan's maximum bandwidth use, in megabytes (MB).\n\n* `0`, `unlimited`, or `null` — The hosting plan allows unlimited\nbandwidth.\n\n**Note:**\n\nThe `0`, `unlimited`, or `null` values are **only** available to\nusers that possess the corresponding `unlimited` ACL permission.","required":"false","in":"query","name":"bwlimit"},{"required":"false","name":"max_email_per_hour","in":"query","schema":{"example":"unlimited","default":"unlimited","oneOf":[{"minimum":"0","type":"integer","maximum":"999999"},{"enum":["unlimited"],"type":"string"}]},"description":"The maximum number of emails that the hosting plan allows accounts to send\nin one hour.\n\n* `0` or `unlimited` — The hosting plan allows unlimited emails per hour."},{"required":"false","in":"query","name":"max_defer_fail_percentage","schema":{"oneOf":[{"type":"integer","minimum":"0"},{"type":"string","enum":["unlimited"]}],"example":"unlimited","default":"unlimited"},"description":"The percentage of failed or deferred email messages that an account on the\nhosting plan can send per hour before outgoing mail is rate-limited.\n\n* `0` or `unlimited` — The hosting plan allows unlimited email messages per hour."},{"required":"false","in":"query","name":"digestauth","schema":{"type":"integer","example":"1","enum":["1","0"],"default":"0"},"description":"Whether to enable Digest Authentication for accounts on the hosting plan.\n\n* `1` — Enable.\n* `0` — Disable."},{"required":"false","in":"query","name":"_PACKAGE_EXTENSIONS","schema":{"type":"string"},"examples":{"multiple":{"summary":"Add multiple package extensions.","value":"extension1 extension2 extension3"},"single":{"summary":"Add a single package.","value":"extension1"}},"description":"The hosting plan's [package extensions](https://go.cpanel.net/GuidetoPackageExtensions).\n\nIf you do **not** provide a value, the hosting plan will **not** include package\nextensions.\n\n**Note:**\n\n* We **strongly** recommend that you manage package extensions through WHM API\n1's `addpkgext` and `delpkgext` functions.\n* You can include the extension's variables in your function call, in `key=value` format.\nConsult the extension's documentation for a list of possible variables.\n* Extension names and variables are case-sensitive.\n* Use space-delimited format to add multiple package extensions."}],"summary":"Update hosting plan","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  editpkg \\\n  name='package1'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/editpkg?api.version=1&name=package1"}],"tags":["Packages","Hosting Plans"]}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Hosting Plans"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"set_scoped_userdata":{"tags":[{"name":"UserData","description":"Scoped userdata storage functions."}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"UserData","tags":["UserData"]}],"paths":{"/set_scoped_userdata":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  set_scoped_userdata \\\n  scope='example_scope' \\\n  key='theme' \\\n  value='dark'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_scoped_userdata?api.version=1&scope=example_scope&key=theme&value=dark"}],"tags":["UserData"],"summary":"Set scoped userdata","x-cpanel-api-version":"WHM API 1","parameters":[{"name":"scope","in":"query","required":"true","description":"The scope name to modify.","schema":{"example":"example_scope","type":"string"}},{"description":"The userdata key to set.\n\n**Note:** The \"json\" argument cannot be used with the \"key\" or \"value\" arguments.","schema":{"type":"string","example":"theme"},"in":"query","name":"key","required":"false"},{"schema":{"type":"string","example":"dark"},"description":"The value to assign to the key.\n\n**Note:** The \"json\" argument cannot be used with the \"key\" or \"value\" arguments.","required":"false","name":"value","in":"query"},{"required":"false","in":"query","name":"json","schema":{"type":"string","example":"{\"theme\":\"dark\"}"},"description":"A json string to save to the specified scope.\n\n**Note:** The \"json\" argument cannot be used with the \"key\" or \"value\" arguments."}],"operationId":"set_scoped_userdata","description":"This function sets (creates or updates) a userdata key/value pair within the specified scope and returns the full updated mapping.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"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":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"command":{"example":"set_scoped_userdata","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"additionalProperties":{"type":"string"},"type":"object","description":"The updated mapping of all userdata in the scope.","example":{"items_per_page":"50","theme":"dark"}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86"}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."}},"cpgreylist_save_common_mail_providers_config":{"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"description":"Mail / Spam Protection (Greylisting)","name":"Spam Protection (Greylisting)"}],"paths":{"/cpgreylist_save_common_mail_providers_config":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_save_common_mail_providers_config\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_save_common_mail_providers_config?api.version=1"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"summary":"Update Greylisting new mail provider handling","x-cpanel-api-version":"WHM API 1","operationId":"cpgreylist_save_common_mail_providers_config","description":"This function sets whether Greylisting trusts new entries to cPanel's common mail providers list.","parameters":[{"schema":{"type":"integer","default":"1","enum":["0","1"],"example":"1"},"description":"Whether Greylisting automatically trusts new mail providers that cPanel adds to the common mail providers list.\n\n* `1` — Automatically trust new mail providers cPanel adds to the common mail providers list.\n* `0` — Do **not** automatically trust new mail providers cPanel adds to the common mail providers list.","required":"false","in":"query","name":"autotrust_new_common_mail_providers"},{"schema":{"enum":["0","1"],"example":"0","type":"integer"},"description":"Whether Greylisting automatically trusts new IP addresses that cPanel adds to this mail provider.\n\n* `1` — Automatically trust new IP addresses cPanel adds to this mail provider.\n* `0` — Do **not** automatically trust new IP addresses cPanel adds to this mail provider.\n\nIf you do not specify this parameter, the system will **not** change Greylisting settings for **any** existing provider.\n\n**Note:**\n\n The parameter's name is the provider's key name.\n Example key and value:\n * `google=0`","required":"false","in":"query","name":"PROVIDERKEY"}],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"cpgreylist_load_common_mail_providers_config","description":"The method name called."}}},"data":{"properties":{"common_mail_providers":{"description":"An object containing common mail provider settings.","example":{"sectigo":{"autoupdate":"1","is_trusted":"1","display_name":"Comodo/Sectigo"},"cpanel":{"autoupdate":"1","is_trusted":"1","display_name":"cPanel"}},"type":"object","additionalProperties":{"properties":{"display_name":{"example":"cPanel","description":"The mail provider's name.","type":"string"},"is_trusted":{"type":"integer","description":"Whether Greylisting trusts this mail provider's IP addresses.\n\n* `1` - The provider is trusted.\n* `0` - The provider is **not** trusted.","enum":["0","1"],"example":"1"},"autoupdate":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether Greylisting automatically trusts new IP addresses that WebPros International, LLC adds for this mail provider.\n\n* `1` - New IP addresses are automatically trusted.\n* `0` - New IP addresses are **not** automatically trusted."}},"type":"object","description":"An object containing the provider's data.\n\n**Note:**\n\n  The object's name is the provider's key name."}},"autotrust_new_common_mail_providers":{"enum":["0","1"],"example":"1","description":"Whether Greylisting automatically trusts new mail providers that WebPros International, LLC adds to the common mail providers list.\n\n* `1` - New mail providers are automatically trusted.\n* `0` - New mail providers are **not** automatically trusted.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"list_services_cluster_nodes":{"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/list_services_cluster_nodes":{"get":{"operationId":"list_services_cluster_node","description":"This function lists the existing nodes in the services cluster.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","x-cpanel-internal-only":"true","parameters":[],"x-cpanel-available-version":"11.110","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing services cluster nodes data.","items":{"properties":{"external_ips":{"items":{"example":"192.168.0.1","type":"string"},"description":"An array of the node's external IP addresses.","type":"array"},"is_server":{"description":"* `1` - The node is acting as a server node in the cluster.\n* `0` - The node is not acting as a server node in the cluster.","enum":["0","1"],"example":"1","type":"integer"},"conditions":{"description":"An array of objects representing the node's status conditions.","items":{"type":"object"},"type":"array"},"hostname":{"example":"node1.example.com","format":"hostname","description":"A string representing the node's hostname.","type":"string"},"labels":{"additionalProperties":{"type":"string","description":"The value portion of label's key/value pair.","example":"my-label-value"},"type":"object","example":{"my-other-key":"my-other-value","my-label-key":"my-label-value"},"description":"A map of key/value pairs representing the node's labels."},"internal_ips":{"type":"array","description":"An array of the node's internal IP addresses.","items":{"example":"192.168.0.1","type":"string"}},"is_agent":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - The node is acting as an agent node in the cluster.\n* `0` - The node is not acting as an agent node in the cluster."},"comment":{"type":"string","example":"This is my favorite cluster node.","description":"A free-form note about this cluster node."}}}}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"delete_services_cluster_node","description":"The method name called.","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}},"tags":["ServicesCluster"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  delete_services_cluster_node \\\n  host='node1.example.com' \\\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_services_cluster_node?api.version=1&host=node1.example.com"}],"x-cpanel-api-version":"WHM API 1","summary":"Delete a node from the services cluster."}}},"x-tagGroups":[{"tags":["ServicesCluster"],"name":"ServicesCluster"}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"ServicesCluster","description":"The ServicesCluster module for WHM API 1."},{"description":"ServicesCluster","name":"ServicesCluster"}]},"uapi_cpanel":{"tags":[{"description":"API Development Tools / API Execution","name":"API Execution"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["API Execution"],"name":"API Development Tools"}],"paths":{"/uapi_cpanel":{"get":{"summary":"Run UAPI function through WHM API","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["API Execution"],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"uapi_cpanel","type":"string"},"result":{"type":"integer","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"}}},"data":{"type":"object","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":{"messages":null,"warnings":null,"metadata":{"transformed":"1"},"data":[{"role":"WebServer","id":"addondomains","percent":"0","name":"addondomains","feature":"addondomains","module":"Park","_count":"0","percent10":"0","zeroisunlimited":"0","count":"0","maxed_phrase":"You are using your maximum allotment ([numf,_1]) of addon domains.","phrase":"Addon Domains","near_limit_phrase":"You are using [numf,_1] of [numf,_2] available addon [numerate,_2,domain,domains].","percent20":"0","item":"Addon Domains","is_maxed":"0","max":"unlimited","percent5":"0","_max":"unlimited","_maxed":"0"}],"status":"1","errors":null},"type":"object","properties":{"metadata":{"type":"object","properties":{"transformed":{"example":"1","enum":["0","1"],"description":"- 1 - A transform was applied.\n- 0 - A transform was not applied.","type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":["0","1"],"example":"1","type":"integer"},"errors":{"type":"array","description":"List of errors produced the by the API if any.","items":{"type":"string"},"nullable":"true"},"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."},"warnings":{"type":"array","items":{"type":"string"},"description":"List of warnings produced the by the API if any.","nullable":"true"},"messages":{"items":{"type":"string"},"description":"List of messages produced the by the API if any.","nullable":"true","type":"array"}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"uapi_cpanel","description":"This function calls a UAPI function through the WHM API. This function's output will match the UAPI function that it calls.","parameters":[{"schema":{"type":"string","example":"get_stats"},"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`","required":"true","in":"query","name":"cpanel.function"},{"required":"true","in":"query","name":"cpanel.module","schema":{"example":"StatsBar","type":"string"},"description":"The UAPI function's cPanel module."},{"required":"true","name":"cpanel.user","in":"query","schema":{"type":"string","example":"username"},"description":"The cPanel username to call with the UAPI function."}]}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"getminimumpasswordstrengths":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"name":"Server Administration","tags":["Security"]}],"paths":{"/getminimumpasswordstrengths":{"get":{"operationId":"getminimumpasswordstrengths","description":"This function retrieves the minimum password strength for cPanel & WHM accounts.","parameters":[{"in":"query","name":"name","required":"false","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","schema":{"enum":["default","cpaddons","createacct","ftp","list","mysql","passwd","postgres","sshkey","virtual"],"example":"default","type":"string"}}],"x-cpanel-available-version":"82","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","description":"The method name called.","example":"getminimumpasswordstrengths"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}},"data":{"type":"object","properties":{"sshkey":{"example":"50","description":"The minimum password strength for SSH keys.","maximum":"100","type":"integer","minimum":"0"},"mysql":{"minimum":"0","maximum":"100","type":"integer","example":"50","description":"The minimum password strength for MySQL® database users."},"createacct":{"minimum":"0","maximum":"100","type":"integer","example":"50","description":"The minimum password strength for new cPanel accounts."},"list":{"maximum":"100","type":"integer","minimum":"0","example":"50","description":"The minimum password strength for mailing lists."},"cpaddons":{"example":"50","description":"The minimum password strength for cPAddons.","maximum":"100","type":"integer","minimum":"0"},"postgres":{"example":"50","description":"The minimum password strength for PostgreSQL database users.","minimum":"0","maximum":"100","type":"integer"},"passwd":{"type":"integer","maximum":"100","minimum":"0","description":"The minimum password strength for WHM user or system accounts.","example":"50"},"ftp":{"example":"50","description":"The minimum password strength for FTP accounts.","maximum":"100","type":"integer","minimum":"0"},"virtual":{"description":"The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.","example":"50","type":"integer","maximum":"100","minimum":"0"},"default":{"description":"The minimum password strength for **all** services.","example":"50","type":"integer","maximum":"100","minimum":"0"}}}},"type":"object"}}}}},"tags":["Security"],"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","summary":"Return minimum password strength"}}},"tags":[{"name":"Security","description":"The Security module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}]},"getzonerecord":{"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{"getzonerecordResponseTypeSSHFP":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"fptype":{"example":"1","enum":["1"],"description":"The public key's fingerprint type.\n\n* `1` - SHA-1","type":"integer"},"algorithm":{"example":"1","enum":["1","2"],"description":"The public key's algorithm number.\n\n* `1` - RSA\n* `2` - DSS\n\n**Note:**\n\nFor more information about SSHFP records, read [RFC 4255 at IANA](http://tools.ietf.org/html/rfc4255).\n\n**Warning:**\n\n* We do **not** currently support this DNS record type.","type":"integer"}}}]},"getzonerecordResponseTypeA6":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"prefix":{"type":"integer","minimum":"1","deprecated":"true","description":"The record's prefix length.","example":"48"},"refer":{"description":"The record's address suffix.\n\n**Important:**\n\nA6 records are **deprecated**. We **strongly** recommend that you use AAAA records to\nstore IPv6 addresses.","example":"0::0","deprecated":"true","type":"string"}},"type":"object"}]},"getzonerecordResponseTypeA":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"address":{"type":"string","example":"192.168.0.20","description":"The zone record's IPv4 address.\n\n**Note:**\n\nFor more information about A records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"ipv4"}},"type":"object"}]},"getzonerecordResponseBase":{"discriminator":{"propertyName":"type","mapping":{"HINFO":"#/components/schemas/getzonerecordResponseTypeHINFO","DNAME":"#/components/schemas/getzonerecordResponseTypeDNAME","CAA":"#/components/schemas/getzonerecordResponseTypeCAA","CNAME":"#/components/schemas/getzonerecordResponseTypeCNAME","AAAA":"#/components/schemas/getzonerecordResponseTypeAAAA","TXT":"#/components/schemas/getzonerecordResponseTypeTXT","SRV":"#/components/schemas/getzonerecordResponseTypeSRV","ALIAS":"#/components/schemas/getzonerecordResponseTypeALIAS","AFSDB":"#/components/schemas/getzonerecordResponseTypeAFSDB","DS":"#/components/schemas/getzonerecordResponseTypeDS","A6":"#/components/schemas/getzonerecordResponseTypeA6","PTR":"#/components/schemas/getzonerecordResponseTypePTR","RP":"#/components/schemas/getzonerecordResponseTypeRP","NS":"#/components/schemas/getzonerecordResponseTypeNS","A":"#/components/schemas/getzonerecordResponseTypeA","SSHFP":"#/components/schemas/getzonerecordResponseTypeSSHFP","MX":"#/components/schemas/getzonerecordResponseTypeMX","SOA":"#/components/schemas/getzonerecordResponseTypeSOA","LOC":"#/components/schemas/getzonerecordResponseTypeLOC"}},"properties":{"Line":{"example":"24","description":"The zone record's file line number.","minimum":"1","type":"integer"},"class":{"example":"IN","description":"The record's class.","oneOf":[{"type":"string","enum":["IN"]},{"type":"string","description":"A valid DNS record class."}]},"ttl":{"description":"The record's Time To Live (TTL), in seconds.","example":"86400","minimum":"1","type":"integer"},"type":{"description":"The DNS record type.\n* `A` - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.\n* `A6`- A6 records store IPv6 addresses.\n* `AAAA` - AAAA records store IPv6 addresses.\n* `AFSDB` - AFSDB records store the location of an AFS cell's database servers.\n* `ALIAS` - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type. \n* `CAA` - CAA records control which certificate authorities can issue SSL certificates for a domain.\n* `CNAME` - CNAME records create an alias to another hostname.\n* `DNAME` - DNAME records create an alias for a hostname and its subnames.\n* `DS` - DS records specify a record's delegation signer.\n* `HINFO` - HINFO records specify a host's CPU and OS types.\n* `LOC` - LOC records store a hostname's geographical location.\n* `MX` - MX records point a domain name to its MTAs.\n* `NS` - NS records store a domain's authoritative nameservers.\n* `PTR` - PTR records point to a CNAME.\n* `RP` - RP records store a domain's Responsible Person's information.\n* `SOA` - SOA records designate the beginning of a zone of authority.\n* `SRV` - SRV records store the service location records for newer protocols (for example, Autodiscover).\n* `SSHFP` - SSHFP records store a domain's SSH public host key's fingerprint.\n* `TXT` - TXT records store descriptive text or useful records (for example, SPF or DKIM records).\n\n **Warning:**\n\n  We do not currently support the SSHFP DNS record type.\n\nThis function will return a differently depending on which record type you query. Select a zone\nrecord type from the menu to view each set of return data:","example":"A","enum":["A","AAAA","AFSDB","ALIAS","CAA","CNAME","DNAME","DS","HINFO","LOC","MX","NS","PTR","RP","SOA","SRV","SSHFP","TXT"],"type":"string"},"name":{"type":"string","example":"hostname.example.com.","format":"domain","description":"The record's name."}},"type":"object"},"getzonerecordResponseTypeALIAS":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"alias":{"type":"string","format":"domain","description":"The hostname you want to point to.\n\n**Note:**\n\nWe strongly recommend that you do not use this function.\nUsing the ALIAS DNS record may result in unexpected behavior, including website downtimes outside of your control, inconsistency in the handling of the record, and security vulnerabilities.\nThis record is only available if you enable access to it and use PowerDNS.","example":"hostname.example.com"}}}]},"getzonerecordResponseTypeRP":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"mbox":{"description":"The Responsible Person's (RP) email address.\n\n**Note:**\n\nFor more information about RP records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183).","example":"user.example.com.","type":"string"},"txtdname":{"description":"The RP's domain name.","format":"domain","example":"mx1.host.example.com.","type":"string"}}}]},"getzonerecordResponseTypeAFSDB":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"hostname":{"example":"hostname.example.com","format":"domain","description":"The database servers' hostname.","type":"string"},"subtype":{"example":"1","description":"The 16-bit integer of an AFS cell type.\n\n**Note:**\n\nFor more information about AFSDB records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183).","type":"integer"}},"type":"object"}]},"getzonerecordResponseTypeSOA":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"mname":{"type":"string","example":"ns1.host.example.com","format":"domain","description":"The domain's authoritative nameserver."},"refresh":{"description":"The amount of time, in seconds, to wait before the secondary DNS server queries the primary DNS server's SOA records for changes.","example":"1440","minimum":"1","type":"integer"},"rname":{"type":"string","example":"user.example.com.","description":"The Responsible Person's (RP) email address."},"retry":{"minimum":"1","type":"integer","description":"The amount of time, in seconds, to wait before the secondary server retries a failed zone transfer.","example":"14400"},"expire":{"type":"integer","minimum":"1","description":"The amount of time, in seconds, to wait before the secondary server attempts to complete a zone transfer.","example":"3600000"},"serial":{"description":"The zone file's revision number.\n\n**Note:**\n\nFor more information about SOA records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"2013122501","type":"integer"},"Lines":{"minimum":"1","type":"integer","description":"The number of lines in the SOA section.","example":"4"}}}]},"getzonerecordResponseTypeMX":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"exchange":{"format":"domain","description":"The server's location's canonical name (CNAME).","example":"mail.example.com","type":"string"},"preference":{"description":"The record's priority order.\n\n**Note:**\n\n* Lower values have a higher priority order.\n* For more information about MX records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"10","type":"integer"}}}]},"getzonerecordResponseTypeLOC":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"horiz_pre":{"type":"integer","minimum":"1","example":"10","description":"The location's horizontal precision distance, in meters."},"size":{"minimum":"1","type":"integer","example":"10","description":"The diameter of a sphere that encloses the entire location, in meters."},"altitude":{"type":"string","description":"The location's altitude above sea level, in meters.","example":"178m"},"latitude":{"type":"string","description":"The location's latitude.","example":"41 51 54.305 N"},"version":{"type":"integer","description":"The record's version number.\n\n**Note:**\n\nFor more information about LOC records, read [RFC 1876 at IANA](http://tools.ietf.org/html/rfc1876).","example":"0","enum":["0"]},"longitude":{"type":"string","example":"87 36 47.95 W","description":"The location's longitude."},"vert_pre":{"example":"10","description":"The location's vertical precision distance, in meters.","type":"integer","minimum":"1"}},"type":"object"}]},"getzonerecordResponseTypeDS":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"digtype":{"type":"integer","description":"The record's digest type.\n\n* `1` — SHA-1\n* `2` — SHA-256\n* `4` — SHA-384","enum":["1","2","4"],"example":"1"},"keyname":{"description":"The record's KeyTag value.\n\n**Note:**\n\nFor more information about DS records, read [RFC 4034 at IANA](http://tools.ietf.org/html/rfc4034).","example":"2642","type":"integer"},"algorithm":{"example":"5","enum":["1","2","3","4","5","7","8","10","13","14","252","253","254"],"description":"The record's algorithm number.\n\n* `1` - RSAMD5\n* `2` - Diffie-Hellman\n* `3` - DSA/SHA-1\n* `4` - Elliptic Curve\n* `5` - RSA/SHA-1\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* `252` - Indirect\n* `253` - Private DNS\n* `254` - Private OID","type":"integer"}},"type":"object"}]},"getzonerecordResponseTypeAAAA":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"address":{"format":"ipv6","description":"The zone record's IPv6 address.\n\n**Note:**\n\n For more information about AAAA records, read [RFC 3596 at IANA](http://tools.ietf.org/html/rfc3596).","example":"2001:1:42:1::2a","type":"string"}},"type":"object"}]},"getzonerecordResponseTypeDNAME":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"dname":{"description":"The delegation name (DNAME) alias.\n\n**Note:**\n\nFor more information about DNAME records, read [RFC 2672 at IANA](http://tools.ietf.org/html/rfc2672).","format":"domain","example":"hostname.example.com","type":"string"}},"type":"object"}]},"getzonerecordResponseTypeHINFO":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"cpu":{"description":"The host's CPU type.\n\n**Note:**\n\nFor more information about HINFO records, read [RFC 1700 at IANA](http://tools.ietf.org/html/rfc1700.txt).","example":"INTEL-386","type":"string"},"os":{"description":"The host's operating system.","example":"UNIX","type":"string"}}}]},"getzonerecordResponseTypeTXT":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"txtdata":{"description":"The TXT record's data.\n\n**Note:**\n\nFor more information about TXT records, read [RFC 1464 at IANA](http://tools.ietf.org/html/rfc1464).","example":"v=spf1 a -all","type":"string"},"unencoded":{"enum":["1","0"],"example":"0","description":"Whether the TXT record's data is encoded.\n\n* `1` - Encoded.\n* `0` - **Not** encoded.","type":"integer"}},"type":"object"}]},"getzonerecordResponseTypeCAA":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"flag":{"type":"integer","description":"Whether the Certificate Authority (CA) will issue an SSL certificate if the CAA resource record contains unknown property tags.\n\n* `0` - Non-critical. If the CAA Resource Record contains unknown property tags, the CA will issue an SSL certificate.\n* `1` - Critical. If the CAA Resource Record contains unknown property tags, the CA will **not** issue an SSL certificate.\n\n**Note:**\n\nFor more information about CAA record flags and property tags, read the [RFC 6844 documentation](https://tools.ietf.org/html/rfc6844#section-3).","example":"0","enum":["0","1"]},"tag":{"type":"string","description":"The CAA record's property type.\n\n* `issue` - A CA issued a certificate for the domain.\n* `issuewild` - A CA issued a wildcard certificate for the domain.\n* `iodef` - The user specified a URL to which a CA may report policy violations.","example":"issue","enum":["issue","issuewild","iodef"]},"value":{"example":"exampleca.com","description":"The CA's domain or URL. This is a valid [SSL provider](https://sslmate.com/labs/caa/),\n`mailto` URL, or a standard URL.","type":"string"}}}]},"getzonerecordResponseTypeSRV":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"weight":{"type":"integer","description":"A relative weight. The system uses this value to rank entries with the same `priority` value.","example":"2"},"target":{"example":"service.example.com","description":"The service's target host.","format":"domain","type":"string"},"port":{"description":"The target host's port.","example":"389","minimum":"0","type":"integer","maximum":"65535"},"priority":{"example":"0","description":"The target host's priority preference.\n\n**Note:**\n\n* Lower numbers have a higher priority order.\n* For more information about SRV records, read [RFC 2782 at IANA](http://tools.ietf.org/html/rfc2782).","type":"integer"}}}]},"getzonerecordResponseTypePTR":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"ptrdname":{"format":"domain","description":"A pointer to a canonical name (CNAME).\n\n**Note:**\n\nFor more information about PTR records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"hostname.example.com","type":"string"}},"type":"object"}]},"getzonerecordResponseTypeNS":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"type":"object","properties":{"nsdname":{"example":"ns1.example.com","format":"domain","description":"The domain's authoritative nameserver.\n\n**Note:**\n\nFor more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","type":"string"}}}]},"getzonerecordResponseTypeCNAME":{"allOf":[{"$ref":"#/components/schemas/getzonerecordResponseBase"},{"properties":{"flatten":{"type":"integer","description":"Whether the specified CNAME value resolves with the record's IP address.\n\n* `1` - Resolves.\n* `0` - Does not resolve.","example":"1","enum":["0","1"]},"cname":{"type":"string","description":"The canonical name (CNAME) alias.\n\n**Note:**\n\nFor more information about CNAME records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"domain","example":"hostname.example.com"},"flatten_to":{"oneOf":[{"type":"string","example":"192.0.2.27","description":"A valid IPv4 address.","format":"ipv4"},{"type":"string","example":"2001:0db8:85a3:0042:1000:8a2e:0370:7334","description":"A valid IPv6 address.","format":"ipv6"}],"description":"The IP address to which the specified CNAME resolves."}},"type":"object"}]}}},"paths":{"/getzonerecord":{"get":{"parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","example":"example.com"},"description":"The zone record's domain."},{"in":"query","name":"line","required":"true","description":"The zone record's line number.","schema":{"example":"2","type":"integer","minimum":"1"}}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"record":{"type":"array","items":{"$ref":"#/components/schemas/getzonerecordResponseBase"},"description":"An array of objects containing the domain's zone record data."}}},"metadata":{"properties":{"command":{"example":"getzonerecord","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"example":"Record obtained.","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"11","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  getzonerecord \\\n  domain='example.com' \\\n  line='2'\n"},{"lang":"HTTP","label":"URL","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","summary":"Return specific line from domain's DNS configuration"}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Zones"]}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Zones","description":"DNS / DNS Zones"}]},"get_cphulk_excessive_brutes":{"paths":{"/get_cphulk_excessive_brutes":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return login security excessive brute force attacks","tags":["cPHulk","Reporting"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_cphulk_excessive_brutes\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_cphulk_excessive_brutes?api.version=1"}],"x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"excessive_brutes":{"items":{"properties":{"notes":{"type":"string","example":"this was a triumph","description":"The login entry's notes."},"ip":{"anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}],"description":"The IP address of the login attempt.","example":"192.168.0.1"},"timeleft":{"example":"14","description":"The number of minutes that remain before cPHulk removes the block.","type":"number","minimum":"1"},"exptime":{"example":"2014-12-07T00:00:00.000Z","format":"ISO-8601 Date Time (Space Separated)","description":"When the login request will time out.","type":"string"},"logintime":{"type":"string","example":"2014-11-20T00:00:00.000Z","description":"When the login attempt occurred.","format":"ISO-8601 Date Time (Space Separated)"}},"type":"object"},"description":"Information about each brute force attack.","type":"array"}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","description":"The method name called.","example":"get_cphulk_excessive_brutes"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}},"description":"This function retrieves excessive brute force attack entries from the cPHulk database.","operationId":"get_cphulk_excessive_brutes","parameters":[]}}},"x-tagGroups":[{"tags":["Reporting"],"name":"Login Security (cPHulk)"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"description":"Login Security (cPHulk) / Reporting","name":"Reporting"}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"personalization_get":{"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/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","x-cpanel-available-version":"74","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"command":{"type":"string","example":"personalization_get","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}},"data":{"example":{"personalization":{"milk":{"success":"1","value":"cold","reason":"OK"},"coffee":{"reason":"OK","success":"1","value":"hot"}}},"type":"object","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":{"success":{"type":"integer","enum":["1","0"],"description":"Whether the function successfully retrieved the value from\nthe server.\n\n* `1` — Successful.\n* `0` — Unsuccessful."},"value":{"description":"The value stored in the field.\n\n* null — The pair is **not** available in the store.","nullable":"true","type":"string"},"reason":{"description":"An error message describing the failure if the `success` Boolean returns a `0` value.","format":"string"}},"type":"object"}},"type":"object"}}}},"type":"object"}}}}},"x-codeSamples":[{"source":"echo '{\"names\":[\"milk\",\"coffee\"],\"store\":\"beverages\"}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n  personalization_get","lang":"Shell","label":"CLI"},{"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\"}","lang":"HTTP","label":"HTTP Request (Wire Format)"}],"tags":["Server Administration","Account Management"],"requestBody":{"required":"true","content":{"application/json":{"schema":{"properties":{"names":{"nullable":"true","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.","items":{"type":"string"},"example":["milk","coffee"],"type":"array","maxLength":"2048"},"store":{"type":"string","maxLength":"128","example":"beverages","description":"The name under which the values are stored."}},"type":"object"}}}},"summary":"Return data from NVData file","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Accounts / Account Management","name":"Account Management"}]},"backup_skip_users_all_status":{"x-tagGroups":[{"name":"Backups","tags":["Backup Settings"]}],"paths":{"/backup_skip_users_all_status":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason 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":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"backup_skip_users_all_status","description":"The method name called."}}},"data":{"properties":{"reason":{"description":"An object that contains backup configuration status information.","properties":{"running":{"example":"0","enum":["0","1"],"description":"Whether user configuration changes are still in progress.\n\n* `1` - In Progress.\n* `0` - Finished.","type":"integer"},"msg":{"example":"Done","description":"The function's status.","type":"string"},"perc":{"minimum":"0","maximum":"100","type":"integer","example":"100","description":"The percentage of users whose backup status has changed."}},"type":"object"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"backup_skip_users_all_status","description":"This function checks each user's backup configuration status while the `backup_skip_users_all` function runs.","parameters":[],"summary":"Return backup configuration status","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_skip_users_all_status\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all_status?api.version=1"}],"tags":["Backups","Backup Settings"]}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup Settings","name":"Backup Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"cpsc_deploy":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.111.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/cpsc_deploy":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"A key value hash specific to the service that was deployed.","type":"object","additionalProperties":{}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"cpsc_deploy","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.112","parameters":[{"required":"true","in":"query","name":"service","schema":{"example":"database","type":"string"},"description":"The name of the service to deploy."}],"x-cpanel-internal-only":"true","description":"This function deploys a cPCloud Service and consumes the configuration that`cpsc_get_config` returns. The system uses these values for the initial deployment.","operationId":"cpsc_deploy","x-cpanel-api-version":"WHM API 1","summary":"Deploy a cPCloud Service.","tags":["cPCloud"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpsc_deploy \\\n  service=database\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_deploy?api.version=1&service=database"}]}}},"x-tagGroups":[{"name":"cPCloud","tags":["cPCloud"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"cPCloud","description":"cPCloud related WHM API 1 functions."}]},"modsec_assemble_config_text":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"paths":{"/modsec_assemble_config_text":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  modsec_assemble_config_text \\\n  config='modsec_vendor_configs/example.conf'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_assemble_config_text?api.version=1&config=modsec_vendor_configs%2fexample.conf"}],"tags":["ModSecurity","Server Settings"],"summary":"Add ModSecurity configuration file text","x-cpanel-api-version":"WHM API 1","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":[{"in":"query","name":"config","required":"true","description":"The ModSecurity™ configuration filename and file path, relative to the `/etc/apache2/conf/` directory.","schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}},{"in":"query","name":"text","required":"false","description":"The text to add to the configuration file.","schema":{"example":"newtext","default":"","type":"string"}},{"schema":{"type":"integer","default":"0","example":"1","enum":["1","0"]},"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.","required":"false","name":"init","in":"query"},{"name":"final","in":"query","required":"false","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.","schema":{"example":"1","enum":["1","0"],"default":"0","type":"integer"}},{"required":"false","in":"query","name":"deploy","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."}],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"modsec_assemble_config_text","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"resolvedomainname":{"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"Domain Management","description":"DNS / Domain Management"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"paths":{"/resolvedomainname":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return domain's IP address","tags":["DNS","Domain Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  resolvedomainname \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/resolvedomainname?api.version=1&domain=example.com","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.28","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"ip":{"type":"string","example":"192.168.0.20","format":"ipv4","description":"The domain's IPv4 address."}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"resolvedomainname","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function resolves a domain's IPv4 address.","operationId":"resolvedomainname","parameters":[{"schema":{"type":"string","example":"example.com","format":"domain"},"description":"The domain.","required":"true","name":"domain","in":"query"}]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."}},"terminate_cpuser_mailbox_sessions":{"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"cPanel Account Mail Management","description":"Mail / cPanel Account Mail Management"}],"servers":[{"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."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["cPanel Account Mail Management"],"name":"Mail"}],"paths":{"/terminate_cpuser_mailbox_sessions":{"get":{"x-cpanel-available-version":"90","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"terminate_cpuser_mailbox_sessions","description":"The method name called."},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"operationId":"terminate_cpuser_mailbox_sessions","description":"This function terminates all IMAP and POP3 connections for a cPanel account.\n\n**Note:**\n\nThis function ends connections for every email address, which includes the [default address](https://go.cpanel.net/cpaneldocsDefaultAddress).","parameters":[{"description":"The cPanel account's username.","schema":{"type":"string","format":"username","example":"username"},"in":"query","name":"username","required":"true"}],"summary":"Stop cPanel account IMAP and POP3 connections","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  terminate_cpuser_mailbox_sessions \\\n  username='username'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/terminate_cpuser_mailbox_sessions?api.version=1&username=username","lang":"HTTP","label":"URL"}],"tags":["Mail","cPanel Account Mail Management"]}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.91.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"}},"package_manager_resolve_actions":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","x-tagGroups":[{"tags":["List Package Information"],"name":"System Package Management"}],"paths":{"/package_manager_resolve_actions":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"uninstall":{"example":["ea-apache24-mod_cgi","ea-apache24-mod_mpm_prefork"],"items":{"type":"string"},"description":"A list of RPM packages that the system would uninstall if you provisioned them as currently selected.","type":"array"},"upgrade":{"example":["ea-php56"],"items":{"type":"string"},"description":"A list of RPM packages that the system would upgrade if you provisioned them as currently selected.","type":"array"},"unaffected":{"description":"A list of unaffected RPM packages.","items":{"type":"string"},"example":["ea-php70-php-devel","ea-php56-runtime","ea-php55-php-common","ea-apache24-mod_headers","ea-php56-php-bcmath","ea-php70-php-curl","ea-php70-php-xml"],"type":"array"},"install":{"type":"array","example":["ea-apache24-mod_mpm_event","ea-apache24-mod_cgid"],"items":{"type":"string"},"description":"A list of RPM packages that the system would install if you provisioned them as currently selected."}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"example":"package_manager_resolve_actions","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52","parameters":[{"examples":{"multiple":{"value":"package=ea-apache24-mod_headers package=ea-apache24-mod_cgid package=ea-apache24-mod_mpm_event","summary":"Submit multiple RPM packages."},"single":{"summary":"Submit a single RPM package.","value":"ea-apache24-mod_headers"}},"description":"The name of an RPM package.\n\n**Note:**\n\n* To submit more than one package, pass the parameter multiple times. For example,\n`package=ea-php55` and `package=ea-apr-util`.","schema":{"type":"string"},"in":"query","name":"package","required":"true"},{"schema":{"type":"string","enum":["ea"]},"examples":{"single":{"summary":"Operate under one namespace.","value":"ea"},"multiple":{"summary":"Operate under multiple namespaces.","value":"ns=ea ns=altea"}},"description":"The RPM namespace that represents a set of packages.\n**Note:**\n* `ea` and any from `ea4_get_additional_pkg_prefixes` API call are the **only** possible values. * When more than one namespace is involved, pass the parameter multiple times. For example, `ns=ea` and `ns=altea`.","required":"false","name":"ns","in":"query"}],"description":"This function determines the actions that would result from the provisioning of a specified RPM package or packages.","operationId":"package_manager_resolve_actions","summary":"Return possible RPM package changes","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_resolve_actions \\\n  package='ea-apache24-mod_headers'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_resolve_actions?api.version=1&package=ea-apache24-mod_headers","label":"URL","lang":"HTTP"}],"tags":["RPM","List Package Information"]}}},"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"description":"System Package Management / List Package Information","name":"List Package Information"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"ipv6_range_edit":{"paths":{"/ipv6_range_edit":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","example":"ipv6_range_edit","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.40","parameters":[{"required":"true","name":"name","in":"query","schema":{"type":"string","example":"ExampleRange"},"description":"The IPv6 address range's current name.\n\n**Note:**\n\nYou **cannot** edit the range named SHARED."},{"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.","schema":{"type":"string","example":"AnotherRange","default":null},"in":"query","name":"new_name","required":"false"},{"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.","schema":{"default":null,"example":"This is an update to the note.","type":"string"},"name":"note","in":"query","required":"false"}],"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","summary":"Update IPv6 address range name or note","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ipv6_range_edit \\\n  name='ExampleRange'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_edit?api.version=1&name=ExampleRange"}],"tags":["IP Addresses","IPv6 Address Settings"]}}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv6 Address Settings"]}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"name":"IPv6 Address Settings","description":"IP Address Management / IPv6 Address Settings"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"validate_current_spfs":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"paths":{"/validate_current_spfs":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"validate_current_spfs","type":"string"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}},"data":{"properties":{"payload":{"type":"array","example":[{"records":[{"state":"FAIL","current":"v=spf1 ~all","reason":"example.com: Sender is not authorized by default to use 'example.com' in 'helo' identity (mechanism '-all' matched)"}],"domain":"example.com","ip_version":"6","expected":"ip6:0:0:0:0:0:ffff:c0a8:101","ip_address":"0:0:0:0:0:ffff:c0a8:101","state":"VALID"},{"error":"(XID rm8h9f) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “example2.com”’s “TXT” records.","records":[],"domain":"example2.com","ip_version":"4","ip_address":"198.252.32.45","state":"ERROR"}],"description":"An array of objects containing information about a domain's SPF records.","items":{"type":"object","properties":{"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"},"state":{"type":"string","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"]},"ip_version":{"type":"integer","description":"The IP address version.\n\n* `4` — IPv4.\n* `6` — IPv6.","enum":["4","6"]},"ip_address":{"anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}],"description":"The domain's IPv4 or IPv6 address."},"domain":{"format":"domain","description":"The queried domain.","type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"state":{"enum":["PASS","NEUTRAL","FAIL","SOFTFAIL","TEMPERROR","PERMERROR"],"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).","type":"string"},"current":{"description":"The SPF record's contents.","type":"string"},"reason":{"description":"The reason for the SPF record's status.","type":"string"}}},"description":"The SPF records of the domain's DNS."},"expected":{"type":"string","description":"The SPF record for the domain in the DNS."}}}}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"78","parameters":[{"examples":{"multiple":{"summary":"Check multiple domains.","value":"domain-1=example.com domain-2=example2.com domain-3=example3.com"},"multiple-alternative":{"value":"domain=example.com domain=example2.com domain=example3.com","summary":"Check multiple domains."},"single":{"value":"example.com","summary":"Check a single domain."}},"description":"The domain for which to check the SPF records.","schema":{"type":"string","format":"domain"},"name":"domain","in":"query","required":"true"}],"operationId":"validate_current_spfs","description":"This function validates a Sender Policy Framework (SPF) record for one or more domains.","x-cpanel-api-version":"WHM API 1","summary":"Validate domain SPF records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  validate_current_spfs \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_spfs?api.version=1&domain=example.com"}]}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"nginxmanager_rebuild_cache_config":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"tags":["NGINX Manager"],"name":"NGINX Manager"}],"paths":{"/nginxmanager_rebuild_cache_config":{"get":{"summary":"Update NGINX configuration.","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  nginxmanager_rebuild_cache_config\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_rebuild_cache_config?api.version=1"}],"tags":["NGINX Manager"],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"example":"nginxmanager_rebuild_cache_config","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"description":"This function rebuilds the NGINX user configuration.","operationId":"nginxmanager_rebuild_cache_config","parameters":[{"schema":{"example":["unclebob","auntsue"],"items":{"type":"string","format":"username"},"format":"username","default":[],"type":"array"},"explode":"true","description":"A list of users whose configuration you want to rebuild.\n\n**Note:**\n\nIf you do not pass this parameter, this function rebuilds the configuration for all users on the system.","style":"form","required":"false","in":"query","name":"user"}]}}},"tags":[{"name":"NGINX Manager","description":"The NGINX Manager module for WHM API 1."}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"nginxmanager_set_cache_config":{"x-tagGroups":[{"name":"NGINX Manager","tags":["NGINX Manager"]}],"paths":{"/nginxmanager_set_cache_config":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update NGINX caching status.","tags":["NGINX Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  nginxmanager_set_cache_config \\\n  enabled='1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_set_cache_config?api.version=1&enabled=1","label":"URL","lang":"HTTP"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"nginxmanager_set_cache_config"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"name":"user","in":"query","required":"false","description":"A list of users whose caching you want to enable or disable.\n\n**Note:**\n\nIf you do not pass this parameter, this function sets the caching status for all users on the system.","style":"form","schema":{"example":["unclebob","auntsue"],"format":"username","items":{"type":"string","format":"username"},"default":[],"type":"array"},"explode":"true"},{"schema":{"enum":["1","0"],"example":"1","type":"integer"},"description":"Whether to enable to disable caching.\n\n**Note:**\n\n* `1` - Enables caching.\n* `0` - Disables caching.","required":"true","name":"enabled","in":"query"}],"description":"This function enables or disables NGINX caching.","operationId":"nginxmanager_set_cache_config"}}},"tags":[{"name":"NGINX Manager","description":"The NGINX Manager module for WHM API 1."}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"listips":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"description":"IP Address Management / IPv4 Address Settings","name":"IPv4 Address Settings"}],"paths":{"/listips":{"get":{"description":"This function lists a server's IP addresses.","operationId":"listips","parameters":[],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"ip":{"type":"array","description":"An array of objects that contain IP address information.","items":{"type":"object","properties":{"mainaddr":{"enum":["0","1"],"example":"0","description":"Whether the IP address is the server's main IP address.\n* `1` — Main IP address.\n* `0` — **Not** the main IP address.","type":"integer"},"removable":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether the IP address can be removed.\n* `1` — Removable.\n* `0` — **Not** removable."},"dedicated":{"description":"Whether the IP address is dedicated.\n* `1` — Dedicated.\n* `0` — Shared.","example":"0","enum":["0","1"],"type":"integer"},"public_ip":{"type":"string","example":"10.1.32.177","description":"The public IP for the IP address.","format":"ipv4"},"active":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether the IP address is active.\n* `1` — Active.\n* `0` — Inactive."},"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"},"if":{"type":"string","description":"The IP address' network interface.","example":"eth0"},"netmask":{"description":"The IP address' netmask.","format":"ipv4","example":"255.255.0.0","type":"string"},"network":{"type":"string","example":"192.168.0.0","format":"ipv4","description":"The IP address' network value."},"ip":{"description":"The IP address.","format":"ipv4","example":"192.168.0.20","type":"string"}}}}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"listips"}}}}}}},"description":"HTTP Request was successful."}},"tags":["IP Addresses","IPv4 Address Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  listips\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/listips?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return server's IP addresses"}}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv4 Address Settings"]}],"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"purchase_a_license":{"x-tagGroups":[{"name":"Server Administration","tags":["License Management"]}],"paths":{"/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.","schema":{"type":"string","example":"cPStore"},"in":"query","name":"provider","required":"true"},{"schema":{"format":"url","example":"http://hostname.example.com","type":"string"},"description":"The location to which the cPanel Store or cPanel Market provider directs the user after the checkout process finishes.","required":"true","in":"query","name":"url_after_checkout"},{"description":"The login token to access the cPanel Store.","schema":{"example":"1a676e6f-99fc-11e6-9ab6-e60a769b73bc","type":"string"},"name":"login_token","in":"query","required":"true"},{"required":"false","name":"upgrade","in":"query","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"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."}],"x-cpanel-available-version":"62","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","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":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"purchase_a_license","description":"The method name called."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed .Check the `reason` field for more details."}}}}}}},"description":"HTTP Request was successful."}},"tags":["Server Administration","License Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","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"},{"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","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel Store or Market checkout URL"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"License Management","description":"Server Administration / License Management"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2"},"accesshash":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"Authentication / SSH Keys and Connections","name":"SSH Keys and Connections"}],"paths":{"/accesshash":{"get":{"deprecated":"true","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  accesshash \\\n  user='root' \\\n  generate='0'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/accesshash?api.version=1&user=root&generate=0"}],"tags":["SSH Keys and Connections"],"summary":"Return cPanel account access hash","x-cpanel-api-version":"WHM API 1","parameters":[{"name":"user","in":"query","required":"true","description":"The user's name.","schema":{"format":"username","example":"root","type":"string"}},{"schema":{"type":"integer","enum":["0","1"],"example":"0"},"description":"Whether to regenerate the access hash.\n* `1` — Regenerate the access hash.\n* `0` — Do **not** regenerate the access hash.","required":"true","name":"generate","in":"query"}],"operationId":"accesshash","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"accesshash","description":"The method name called."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"accesshash":{"type":"string","example":"cb523f89e9a31123fde7c6f93b580ac05bf00a2804d4febe6667ab9917a14baa1c4914da209bf55c862999ea51983a117a4d2f238140200b1e5b270b94b2c52492747e5ebfdeddb8abf4e1b0c428c6c68b701b48e13dbe39da49450e7a8e5422e18ab3b6290b5b6556bd82ee21d9c1103e7a51d1e94f2ac0c4dcc6a10954b8634c6db16a541660c3c89e10254f05583f4167adfcff7781090ea930647b46e5b981f3e16c7723ca4e12dc4b54a778dc66a28df73632a0d3a8e01e207b9fd6b555b72936a903af014f30061d712d736176a87fb5333c5b90cf0bb4f3c6735f2b45929ac79fb1184045a5f4c20bfcc553f5ab760eec077c0d6096e54d02724201281e441e7b0f642370a63f61c68766e224c8510bc32b0316780660c34352cbfeeccfee9d4f02e20ba7b664d3e84e9419ca386c41df07613f8af252aba8626a8b54796bbe616f41af1e6f11a3d0327f7608d23666fca64e6ebe899f7479a5fb0aea008b1e7a41890c9c58037682450febf91b7aa1c080d31d834b0ae466f8533df838ab271b26a7fb7de96402ad4a818d6b786af92c38414d2ef6c88deb7c685a1e60c3cbcfbf20cf6d2a00dd50d2be9bc1824d91284ec6842dd7db42564dfc3ecb75c1a9bc775c45c5f08784b9e2885c2d","description":"The user's access hash."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"name":"Authentication","tags":["SSH Keys and Connections"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"get_provider_display_configurations":{"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"External Authentication","description":"Authentication / External Authentication"}],"paths":{"/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":[{"name":"provider_id","in":"query","required":"true","description":"The identity provider's key.","schema":{"example":"google","type":"string"}}],"x-cpanel-available-version":"58.0.12","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_provider_display_configurations","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"configurations":{"items":{"type":"object","properties":{"link":{"description":"A reference URL to the identity provider's configuration for the system.","type":"string"},"color":{"type":"string","description":"The background color of the button in the cPanel interface.","format":"RGB"},"display_name":{"type":"string","description":"The display name of the identity provider."},"documentation_url":{"type":"string","format":"url","description":"The URL to the identity provider's documentation."},"icon_type":{"description":"The icon file's MIME type.","type":"string"},"textcolor":{"type":"string","format":"RGB","description":"The color of the text label in the button that the cPanel login interface displays."},"label":{"description":"The text label in the button that the cPanel login interface displays.","type":"string"},"provider_name":{"description":"The name of the identity provider.","type":"string"},"service":{"type":"string","description":"The service's name.\n\n* `cpaneld`\n* `whostmgrd`\n* `webmaild`","enum":["cpaneld","whostmgrd","webmaild"]},"icon":{"type":"string","description":"The icon file in the button that the cPanel login interface displays.","format":"byte"}}},"description":"An array of objects containing information about each service's external authentication display information.","example":[{"label":"Log in via Google","icon_type":"image/svg+xml","textcolor":"FFFFFF","documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect","display_name":"Google","color":"dd4b39","link":"/openid_connect/google","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=","service":"cpaneld","provider_name":"google"},{"textcolor":"FFFFFF","icon_type":"image/svg+xml","label":"Log in via Google","display_name":"Google","documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect","link":"/openid_connect/google","color":"dd4b39","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=","service":"webmaild","provider_name":"google"},{"provider_name":"google","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=","service":"whostmgrd","display_name":"Google","documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect","color":"dd4b39","link":"/openid_connect/google","label":"Log in via Google","textcolor":"FFFFFF","icon_type":"image/svg+xml"}],"type":"array"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_provider_display_configurations \\\n  provider_id='google'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_provider_display_configurations?api.version=1&provider_id=google"}],"tags":["Authentication","External Authentication"],"summary":"Return identity provider login interface appearance","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["External Authentication"],"name":"Authentication"}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"delete_account_archives":{"paths":{"/delete_account_archives":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_account_archives \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_account_archives?api.version=1&user=username"}],"tags":["Transfers","Transfer Configuration"],"summary":"Remove cPanel account's archives","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","name":"user","in":"query","schema":{"format":"username","example":"username","type":"string"},"description":"The cPanel account username."},{"schema":{"type":"string","default":"/home","example":"/home/example/"},"description":"The filepath to the archive storage location.","required":"false","name":"mountpoint","in":"query"}],"description":"This function removes a cPanel user account's archives.","operationId":"delete_account_archives","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"delete_account_archives"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"output":{"type":"object","properties":{"warnings":{"type":"array","description":"An array of warning messages.","items":{"type":"string","example":"This is a warning message."}},"messages":{"description":"An array of status messages.","items":{"type":"string","example":"Found archive: /home/example/example.tar.gz"},"type":"array"}}},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}},"type":"object"}}}}}}},"x-cpanel-available-version":"70"}}},"x-tagGroups":[{"tags":["Transfer Configuration"],"name":"Transfers"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"description":"Transfers / Transfer Configuration","name":"Transfer Configuration"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"restore_config_from_file":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Configuration Clusters"],"name":"Server Administration"}],"paths":{"/restore_config_from_file":{"get":{"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.","schema":{"type":"string","example":"Main"},"in":"query","name":"module","required":"true"},{"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.","schema":{"example":"/var/cpanel/cpanel.config","type":"string"},"in":"query","name":"path","required":"true"}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"restore_config_from_file"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}}}},"x-cpanel-available-version":"74","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_config_from_file \\\n  module='Main' \\\n  path='/var/cpanel/cpanel.config'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_config_from_file?api.version=1&module=Main&path=%2fvar%2fcpanel%2fcpanel.config","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Update configuration file from backup"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Configuration Clusters","name":"Configuration Clusters"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"get_mailbox_status_list":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["cPanel Account Mail Management"],"name":"Mail"}],"paths":{"/get_mailbox_status_list":{"get":{"parameters":[{"description":"The email account's name.","example":"user@example.com","schema":{"type":"string","anyOf":[{"type":"string","description":"A valid email account that exists on the server","format":"email","example":"user@example.com"},{"type":"string","example":"example","format":"username","description":"The cPanel user's account name."},{"example":"_mainaccount@example.com","format":"email","description":"An alias that represents the cPanel user's mailbox","type":"string"}]},"name":"account","in":"query","required":"true"}],"operationId":"get_mailbox_status_list","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","description":"The method name called.","example":"get_mailbox_status_list"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"type":"object","properties":{"mailboxes":{"items":{"type":"object","properties":{"messages":{"minimum":"0","type":"integer","example":"0","description":"The total number of messages in the mailbox."},"mailbox":{"type":"string","example":"INBOX.marla_singer@example_com","description":"The mailbox name."},"guid":{"description":"The alpha-numeric 32-byte mailbox GUID.","example":"1234560f0c58d158c92a000044f0d230","type":"string"},"vsize":{"example":"0","description":"The total virtual size of the mailbox's contents, computed with CRLF line terminators.","format":"bytes","type":"integer","minimum":"0"}}},"description":"An array that contains information about the mailbox's contents.","type":"array"}}}}}}}}},"x-cpanel-available-version":"64","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_mailbox_status_list \\\n  account='user@example.com'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_mailbox_status_list?api.version=1&account=user%40example.com"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Return cPanel account mailboxes status list","x-cpanel-api-version":"WHM API 1"}}}},"set_nsec3_for_domains":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}],"paths":{"/set_nsec3_for_domains":{"get":{"parameters":[{"name":"domain","in":"query","required":"true","description":"The domain for which to enable NSEC3 semantics.","schema":{"type":"string","format":"domain","example":"example.com"}},{"required":"true","in":"query","name":"nsec3_opt_out","schema":{"enum":["0","1"],"example":"0","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 select `1` if you **must** create records for all delegations."},{"name":"nsec3_iterations","in":"query","required":"true","description":"The number of times that the system re-executes the first resource record hash operation.","schema":{"example":"7","type":"integer","maximum":"500","minimum":"0"}},{"in":"query","name":"nsec3_narrow","required":"true","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.","schema":{"type":"integer","enum":["0","1"],"example":"1"}},{"schema":{"example":"1a2b3c4d5e6f","type":"string"},"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).","required":"true","in":"query","name":"nsec3_salt"}],"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","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"domains":{"items":{"type":"object","properties":{"error":{"type":"string","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."},"domain":{"type":"string","example":"example.com","format":"domain","description":"The domain for which the system enabled NSEC3."},"enabled":{"enum":["0","1"],"example":"1","description":"Whether the system enabled NSEC3.\n- `1` — Enabled.\n- `0` — The system failed to enable NSEC3.","type":"integer"}}},"description":"An array of objects that contains information about each domain.","type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason `field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"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"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86","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"},{"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","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable NSEC3 semantics for domain"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / Domain Management","name":"Domain Management"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"update_configclusterserver":{"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Configuration Clusters","description":"Server Administration / Configuration Clusters"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Configuration Clusters"],"name":"Server Administration"}],"paths":{"/update_configclusterserver":{"get":{"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"user":{"example":"root","description":"The server's `root`-level account username.","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"name":{"description":"The remote configureation cluster server's name.","example":"example.com","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"update_configclusterserver","type":"string"},"signature":{"example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","description":"The new remote access key.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"update_configclusterserver","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.","parameters":[{"name":"name","in":"query","required":"true","description":"The remote configuration cluster server's name or IP address.","schema":{"type":"string","example":"example.com"}},{"description":"The server's `root`-level account username. If you do not specify a value, the function does not update the username.","schema":{"example":"root","type":"string"},"in":"query","name":"user","required":"false"},{"required":"false","in":"query","name":"key","schema":{"example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","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."}],"x-cpanel-api-version":"WHM API 1","summary":"Update configuration cluster server credentials","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_configclusterserver \\\n  name='example.com'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/update_configclusterserver?api.version=1&name=example.com","label":"URL","lang":"HTTP"}]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"add_configclusterserver":{"paths":{"/add_configclusterserver":{"post":{"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"add_configclusterserver","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"signature":{"type":"string","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"},"name":{"description":"The remote configuration cluster server's name.","example":"example.com","type":"string"},"user":{"type":"string","description":"The username for the server's `root`-level account.","example":"root"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"add_configclusterserver","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.","parameters":[{"name":"name","in":"query","required":"true","description":"The remote configuration cluster server's name.","schema":{"example":"example.com","type":"string"}},{"required":"true","name":"user","in":"query","schema":{"example":"root","type":"string"},"description":"The username for the server's `root`-level account."},{"schema":{"type":"string","example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0"},"description":"A truncated version of the server's remote access key.","required":"true","in":"query","name":"key"}],"summary":"Add configuration cluster server","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"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":"CLI","lang":"Shell"},{"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","lang":"HTTP","label":"URL"}],"tags":["Server Administration","Configuration Clusters"]}}},"x-tagGroups":[{"name":"Server Administration","tags":["Configuration Clusters"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Configuration Clusters","description":"Server Administration / Configuration Clusters"}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"ea4_get_currently_installed_packages":{"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"paths":{"/ea4_get_currently_installed_packages":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return installed Easyapache 4 packages","tags":["EasyApache","EasyApache Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ea4_get_currently_installed_packages\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_get_currently_installed_packages?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"62","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"ea4_get_currently_installed_packages","description":"The method name called."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"type":"object","properties":{"packages":{"description":"A list of the currently installed packages.","items":{"type":"string","example":"ea-apache24"},"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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":[]}}},"x-tagGroups":[{"name":"Web Server Configuration","tags":["EasyApache Settings"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The EasyApache module for WHM API 1.","name":"EasyApache"},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"}]},"remote_basic_credential_check":{"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"description":"Transfers / Transfer Configuration","name":"Transfer Configuration"}],"servers":[{"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."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Transfer Configuration"],"name":"Transfers"}],"paths":{"/remote_basic_credential_check":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"output":{"description":"The function call's raw HTML output.","example":"Basic credential check…\nDone\n","type":"string"},"response":{"example":"basic credential check\n","description":"The function call's response.","type":"string"}}},"metadata":{"properties":{"reason":{"type":"string","example":"Success","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","example":"remote_basic_credential_check","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[{"required":"true","in":"query","name":"host","schema":{"anyOf":[{"type":"string","example":"192.168.0.0","description":"A valid IP address.","format":"ipv4"},{"type":"string","format":"domain","description":"A valid domain.","example":"remote.example.com"}]},"description":"The remote server's hostname or IP address.","example":"192.168.0.0"},{"schema":{"maximum":"65535","type":"integer","minimum":"1","example":"22","default":"22"},"description":"The remote server's SSH port number.","required":"false","name":"port","in":"query"},{"description":"The username to use to connect to the remote server.","schema":{"type":"string","format":"username","example":"root"},"name":"user","in":"query","required":"true"},{"in":"query","name":"password","required":"false","description":"The username's password.","schema":{"type":"string","example":"123456luggage"}},{"name":"root_escalation_method","in":"query","required":"false","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.","schema":{"type":"string","example":"sudo","enum":["su","sudo"]}},{"name":"root_password","in":"query","required":"false","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`.","schema":{"example":"123456luggage","type":"string"}},{"schema":{"example":"FrancisScott","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*).","required":"false","in":"query","name":"sshkey_name"},{"required":"false","name":"sshkey_passphrase","in":"query","schema":{"type":"string","example":"kkwtoowoygidsa"},"description":"The SSH key's passphrase.\n\n**Note:**\n\n Use this parameter if the SSH Key is encrypted."}],"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","x-cpanel-api-version":"WHM API 1","summary":"Validate remote server's SSH credentials","tags":["Transfers","Transfer Configuration"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remote_basic_credential_check \\\n  host='192.168.0.0' \\\n  user='root'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_basic_credential_check?api.version=1&host=192.168.0.0&user=root","lang":"HTTP","label":"URL"}]}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"verify_icq_access":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Notifications","name":"Notifications"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}],"paths":{"/verify_icq_access":{"get":{"description":"This function calls WHM API 1's `verify_oscar_access`\nfunction with your specified ICQ accounts. You can specify ICQ\naccounts in the _Contact Information_ section of WHM's [*Basic WebHost Manager\nSetup*](https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/) interface (_Home >> Server Configuration >> Basic WebHost Manager\nSetup_).","operationId":"verify_icq_access","parameters":[],"x-cpanel-available-version":"11.52","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"message_id":{"type":"string","description":"The test message's ID.","example":"554d2cbd-efe61da3cacb"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"verify_icq_access","description":"The method name called."},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}}}},"tags":["Server Administration","Notifications"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  verify_icq_access\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_icq_access?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Validate stored ICQ username and password"}}}},"nat_checkip":{"paths":{"/nat_checkip":{"get":{"parameters":[{"name":"ip","in":"query","required":"true","description":"The local IPv4 address.","schema":{"type":"string","format":"ipv4","example":"192.168.4.10"}}],"operationId":"nat_checkip","description":"This function validates a public IP address on a NAT-configured server.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"checked_ip":{"format":"ipv4","description":"The local IPv4 address.","example":"192.168.4.10","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"nat_checkip","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.40","tags":["IP Addresses","Network Address Translation"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  nat_checkip \\\n  ip='192.168.4.10'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/nat_checkip?api.version=1&ip=192.168.4.10","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Validate public IP address for NAT"}}},"x-tagGroups":[{"tags":["Network Address Translation"],"name":"IP Address Management"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"description":"IP Address Management / Network Address Translation","name":"Network Address Translation"}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"export_zone_files":{"x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"paths":{"/export_zone_files":{"get":{"summary":"Export DNS zones in zone file format","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  export_zone_files \\\n  zone='example.com' zone='example.net'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/export_zone_files?api.version=1&zone=example.com&zone=example.net"}],"tags":["DNS","DNS Zones"],"x-cpanel-available-version":"11.96","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"payload":{"description":"The requested DNS zone texts.","items":{"properties":{"text_b64":{"format":"base64","description":"The DNS zone’s text representation.","type":"string"},"zone":{"type":"string","description":"The DNS zone’s name.","format":"domain"}},"type":"object"},"example":[{"zone":"example.com","text_b64":"AAAABBCCDdshjke=="},{"text_b64":"BBBBCCDDDdshjke==","zone":"example.net"}],"type":"array"}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"description":"The method name called.","example":"export_zone_files","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"operationId":"export_zone_files","description":"This function returns one or more DNS zones, in\n[RFC-1035](https://tools.ietf.org/html/rfc1035) format.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","parameters":[{"name":"zone","in":"query","required":"true","description":"The DNS zones to display.","schema":{"example":["example.com","example.net"],"items":{"type":"string","format":"domain","example":"example.com"},"type":"array"}}]}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Zones","description":"DNS / DNS Zones"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"addpkg":{"paths":{"/addpkg":{"get":{"tags":["Packages","Hosting Plans"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  addpkg \\\n  name='package1'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/addpkg?api.version=1&name=package1"}],"x-cpanel-api-version":"WHM API 1","summary":"Create hosting plan","parameters":[{"description":"The new hosting plan's name.\n\n**Note:**\n\n* You **cannot** use the name `extensions` for a hosting plan.\n* You **cannot** modify hosting plan names after creation. Do **not**\ninclude details that may change over time, such as price.","schema":{"type":"string","example":"package1"},"name":"name","in":"query","required":"true"},{"description":"The hosting plan's feature list.\n\nIf you do **not** use this parameter, the function assigns the `default`\nfeature list to the account.","schema":{"default":"default","example":"feature_list","type":"string"},"name":"featurelist","in":"query","required":"false"},{"in":"query","name":"quota","required":"false","description":"The hosting plan's disk space quota, in megabytes (MB).\n\n* `0`, `unlimited`, or `null` — The hosting plan allows unlimited disk space.\n\n**Note:**\n\nThe `0`, `unlimited`, and `null` values are **only** available to users that possess\nthe corresponding unlimited ACL permission.","schema":{"default":"10240","example":"10240","oneOf":[{"type":"integer","maximum":"999999","minimum":"0"},{"description":"The hosting plan allows unlimited disk space."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}]}},{"description":"Whether the account has a dedicated IP address.\n\n* `y` — The account possesses a dedicated IP address.\n* `n` — The account does not possess a dedicated IP address.","schema":{"type":"string","enum":["y","n"],"example":"n","default":"n"},"name":"ip","in":"query","required":"false"},{"description":"Whether CGI access is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nWhen a\n[server profile](https://go.cpanel.net/whmdocsServerProfile) disables the\n[Web Server role](https://go.cpanel.net/serverroles#roles), this parameter\ndefaults to `0`. On these servers, you **cannot** enable CGI access.","schema":{"default":"1","enum":["1","0"],"example":"1","type":"integer"},"in":"query","name":"cgi","required":"false"},{"required":"false","in":"query","name":"frontpage","description":"Whether Microsoft® FrontPage® Extensions are enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\ncPanel & WHM ignores all FrontPage settings and parameters.","deprecated":"true","schema":{"type":"integer","enum":["1","0"],"example":"0","default":"0"}},{"name":"cpmod","in":"query","required":"false","description":"The hosting plan's cPanel theme.\n\nThis parameter defaults to the server's\n[default cPanel theme](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup#select-a-default-theme-for-the-cpanel-interface).","schema":{"example":"jupiter","type":"string"}},{"schema":{"type":"string","format":"ISO-3166-1 (alpha-2)","example":"en"},"description":"The hosting plan's default locale, in its two-letter\n[ISO-3166 code](http://www.iso.org/iso/country_codes.htm)\nformat.\n\nThis parameter defaults to the server's default locale.","required":"false","in":"query","name":"language"},{"required":"false","in":"query","name":"maxftp","schema":{"oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited FTP accounts."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"default":"unlimited","example":"unlimited"},"description":"The hosting plan's maximum number of FTP accounts.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited FTP accounts."},{"required":"false","name":"maxsql","in":"query","schema":{"default":"unlimited","example":"unlimited","oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited databases."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}]},"description":"The hosting plan's maximum number of each available type of SQL\ndatabase.\n\nFor example, if you set this value to `5` and the system administrator\nallows MySQL® and PostgreSQL® databases, users can create up to five MySQL\ndatabases and up to five PostgreSQL databases.\n\n* `unlimited`, or `null` — The hosting allows unlimited databases."},{"required":"false","in":"query","name":"maxpop","schema":{"oneOf":[{"minimum":"0","type":"integer","maximum":"999999"},{"description":"The hosting plan allows unlimited email accounts."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"example":"unlimited","default":"unlimited"},"description":"The hosting plan's maximum number of email accounts.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited email accounts."},{"in":"query","name":"maxlst","required":"false","description":"The hosting plan's maximum number of mailing lists.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited mailing lists.","schema":{"oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited mailing lists."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"example":"unlimited","default":"unlimited"}},{"name":"maxsub","in":"query","required":"false","description":"The hosting plan's maximum number of subdomains.\n\n* `unlimited`, or `null` — The hosting plan allows unlimited subdomains.","schema":{"oneOf":[{"maximum":"999999","type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited subdomains."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"default":"unlimited","example":"unlimited"}},{"required":"false","in":"query","name":"maxpark","schema":{"oneOf":[{"type":"integer","maximum":"999999","minimum":"0"},{"description":"The hosting plan allows unlimited parked domains."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"example":"unlimited","default":"0"},"description":"The hosting plan's maximum number of parked domains (aliases).\n\n* `unlimited` or `null` — The hosting plan allows unlimited parked domains."},{"required":"false","in":"query","name":"maxaddon","schema":{"oneOf":[{"type":"integer","maximum":"999999","minimum":"0"},{"description":"The hosting plan allows unlimited addon domains."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"example":"unlimited","default":"0"},"description":"The hosting plan's maximum number of addon domains.\n\n* `unlimited` or `null` — The hosting plan allows unlimited addon domains."},{"description":"The hosting plan's maximum number of Team users.","schema":{"example":"7","minimum":"0","type":"integer","maximum":"7"},"name":"max_team_users","in":"query","required":"false"},{"in":"query","name":"hasshell","required":"false","description":"Whether the hosting plan allows shell access.\n\n* `1` — The hosting plan allows shell access.\n* `0` — The hosting plan does **not** allows shell access.","schema":{"default":"0","example":"1","enum":["1","0"],"type":"integer"}},{"name":"bwlimit","in":"query","required":"false","description":"The hosting plan's maximum bandwidth use, in megabytes (MB).\n\n* `0`, `unlimited`, or `null` — The hosting plan allows unlimited bandwidth.\n\n**Note:**\n\nThe `0`, `unlimited`, and `null` values are **only** available to users that possess\nthe corresponding unlimited ACL permission.","schema":{"default":"1048576","example":"1048576","oneOf":[{"minimum":"0","type":"integer","maximum":"999999"},{"description":"The hosting plan allows unlimited bandwidth."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}]}},{"schema":{"example":"1024","default":"1024","oneOf":[{"maximum":"4294967296","type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited email account quota."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}]},"description":"The hosting plan's maximum email account quota size, in megabytes (MB).\n\n* `0`, `unlimited`, or `null` — The hosting plan allows unlimited email account quota.\n\n**Note:**\n\nThe `0`, `unlimited`, and `null` values are **only** available to users that possess\nthe corresponding unlimited ACL permission.","required":"false","name":"max_emailacct_quota","in":"query"},{"description":"The maximum number of emails that the hosting plan allows users to send in one hour.\n\n* `0` or `unlimited` — The hosting plan allows users to send an unlimited number of emails.","schema":{"example":"unlimited","default":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows users to send an unlimited number of emails.","type":"string"}]},"in":"query","name":"MAX_EMAIL_PER_HOUR","required":"false"},{"description":"The percentage of failed or deferred email messages that the hosting plan allows users\nto send per hour before outgoing mail is rate-limited.\n\n* `0` or `unlimited` — The hosting plan allows users ot send an unlimited number of\nfailed or deferred messages.","schema":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows users ot send an unlimited number of failed or deferred messages."}],"example":"unlimited","default":"unlimited"},"in":"query","name":"MAX_DEFER_FAIL_PERCENTAGE","required":"false"},{"description":"Whether to enable Digest Authentication for accounts on the hosting plan.\n\n* `1` — Enable.\n* `0` — Disable.","schema":{"example":"1","enum":["1","0"],"default":"0","type":"integer"},"name":"digestauth","in":"query","required":"false"},{"description":"A space-separated list of the hosting plan's\n[package extensions](https://go.cpanel.net/GuidetoPackageExtensions).\n\nIf you do **not** provide a value, the hosting plan will **not** include package\nextensions.\n\n**Note:**\n\n* We **strongly** recommend that you manage package extensions through WHM API\n1's `addpkgext` and `delpkgext` functions.\n* You can include the extension's variables in your function call, in `key=value` format.\nConsult the extension's documentation for a list of possible variables.\n* Extension names and variables are case-sensitive.","schema":{"example":"'extension1 extension2 extension3'","type":"string"},"in":"query","name":"_PACKAGE_EXTENSIONS","required":"false"}],"description":"This function creates a hosting plan (package).\n\n**Note:**\n\nThe [Access Control Lists](https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists)\nrestricts some of this function's parameters, which limit the features that\nWHM users can access.","operationId":"addpkg","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"pkg":{"description":"The new hosting plan's name.","example":"package1","type":"string"}}},"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"addpkg"},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Hosting Plans"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Hosting Plans / Hosting Plans","name":"Hosting Plans"}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_nameserver_config":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"Resolvers","description":"DNS / Resolvers"}],"paths":{"/get_nameserver_config":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"get_nameserver_config","description":"The method name called.","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"nameservers":{"type":"array","description":"The currently-authenticated user's nameservers.","items":{"type":"string"},"example":["ns1.example.com","ns2.example.com"]}},"type":"object"}}}}}}},"x-cpanel-available-version":"56","parameters":[],"operationId":"get_nameserver_config","description":"This function retrieves the default nameservers for the currently-authenticated user.","x-cpanel-api-version":"WHM API 1","summary":"Return current user's nameservers","tags":["DNS","Resolvers"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_nameserver_config\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_nameserver_config?api.version=1","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"name":"DNS","tags":["Resolvers"]}]},"add_autossl_user_excluded_domains":{"paths":{"/add_autossl_user_excluded_domains":{"get":{"summary":"Disable AutoSSL for domain","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  add_autossl_user_excluded_domains \\\n  username='example' \\\n  domain='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/add_autossl_user_excluded_domains?api.version=1&username=example&domain=example.com","lang":"HTTP","label":"URL"}],"tags":["SSL","Auto-Generated Certificates"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"add_autossl_user_excluded_domains","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"66","parameters":[{"name":"username","in":"query","required":"true","description":"The cPanel user's account.","schema":{"type":"string","example":"example","format":"username"}},{"schema":{"items":{"format":"domain","type":"string"},"type":"array"},"explode":"true","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"]}},"style":"form","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`.","required":"true","name":"domain","in":"query"}],"operationId":"add_autossl_user_excluded_domains","description":"This function disables AutoSSL for an account's specified domains."}}},"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"enable_cphulk":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"name":"Settings","description":"Login Security (cPHulk) / Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Settings"]}],"paths":{"/enable_cphulk":{"get":{"summary":"Enable login security","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  enable_cphulk\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_cphulk?api.version=1"}],"tags":["cPHulk","Settings"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"enable_cphulk","description":"The method name called.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","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.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[],"operationId":"enable_cphulk","description":"This function enables the cPHulk service."}}}},"emailtrack_search":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/emailtrack_search":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"records":{"description":"An array of objects containing the delivery record.","items":{"type":"object","properties":{"type":{"description":"The delivery status.\n* `success`\n* `defer`\n* `failure`\n* `inprogress`","enum":["success","defer","failure","inprogress"],"example":"success","type":"string"},"msgid":{"description":"The message ID.","example":"1RuV0Z-0005NR-BN","type":"string"},"message":{"type":"string","description":"The action taken.","example":"Domain example.com has exceeded the max defers and failures per hour (5/5 (100%)) allowed. Message discarded."},"transport":{"nullable":"true","example":null,"description":"The mail transfer agent (MTA).","type":"string"},"domain":{"type":"string","format":"domain","description":"The sender's domain.","example":"example.com"},"deliveryuser":{"description":"The recipient's username.","example":null,"nullable":"true","type":"string"},"ip":{"example":null,"format":"ipv4","description":"The recipient's IP address.","nullable":"true","type":"string"},"deliverydomain":{"type":"string","nullable":"true","format":"domain","description":"The recipient's domain.","example":null},"size":{"type":"integer","minimum":"1","format":"bytes","description":"The message's size.","example":"1653"},"senderip":{"type":"string","description":"The sender's IP address.","example":"127.0.0.1"},"sendunixtime":{"example":"1328559471","format":"unix_timestamp","description":"When the message was sent.","type":"integer"},"user":{"type":"string","example":"cpanel1","description":"The sender's username."},"recipient":{"example":"user@example.com","description":"The recipient's mail address.","format":"email","type":"string"},"sender":{"description":"The sender's full email address.","example":"user@example.com","type":"string"},"senderauth":{"type":"string","example":"localuser","format":"hostname","description":"The user authentication."},"spamscore":{"type":"integer","minimum":"0","example":"5","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`."},"deliveredto":{"nullable":"true","example":null,"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.","type":"string"},"senderhost":{"type":"string","format":"hostname","description":"The sender's hostname.","example":"localhost"},"actionunixtime":{"example":"1328559471","description":"When the delivery attempt happened.","format":"unix_timestamp","type":"integer"},"host":{"type":"string","nullable":"true","format":"hostname","description":"The hostname that received the message.","example":null},"transport_is_remote":{"type":"integer","description":"Whether the mail transfer agent (MTA) is remote.\n* `1` — Remote.\n* `0` — Not remote.","example":"0","enum":["0","1"]},"actiontime":{"type":"string","description":"When the delivery attempt happened in `YYYY-MM-DD HH-mm-SS` format.","example":"2012-02-06T14:17:51"},"router":{"example":"enforce_mail_permissions","description":"The mail server's internal router name.","type":"string"}}},"type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed: Check the reason field for more details."},"command":{"example":"emailtrack_search","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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":[{"schema":{"default":"0","example":"0","enum":["0","1"],"type":"integer"},"description":"Whether to return successful delivery attempts.\n* `1` — Return successful delivery attempts.\n* `0` — Do not return successful delivery attempts.","required":"false","in":"query","name":"success"},{"required":"false","name":"defer","in":"query","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"description":"Whether to return delivery deferral events.\n* `1` — Return delivery deferral events.\n* `0` — Do not return delivery deferral events."},{"schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"},"description":"Whether to return delivery failure events.\n* `1` — Return delivery failure events.\n* `0` — Do not return delivery failure events.","required":"false","in":"query","name":"failure"},{"required":"false","name":"inprogress","in":"query","schema":{"enum":["0","1"],"example":"0","default":"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."},{"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.","schema":{"type":"string","default":"all","enum":["all","remote","local"],"example":"all"},"name":"deliverytype","in":"query","required":"false"},{"schema":{"type":"integer","example":"3","default":"0"},"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.","required":"false","name":"max_results_by_type","in":"query"}],"x-cpanel-api-version":"WHM API 1","summary":"Return email delivery records by search criteria","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  emailtrack_search\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_search?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}]},"modsec_get_config_text":{"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/modsec_get_config_text":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return ModSecurity configuration file","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_get_config_text \\\n  config='modsec2.example.conf'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_config_text?api.version=1&config=modsec2.example.conf","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"11.46","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"modsec_get_config_text","description":"The method name called.","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"text":{"type":"string","description":"The ModSecurity configuration file's contents.","example":"SecRule REQUEST_URI \"example\" \"deny:id:123456789\" SecAction \"pass:auditlog:id:444444444\""}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"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":[{"schema":{"example":"modsec2.example.conf","type":"string"},"description":"The ModSecurity configuration file's name.","required":"true","name":"config","in":"query"}]}}},"x-tagGroups":[{"tags":["Server Settings"],"name":"Web Server Security (ModSecurity)"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}]},"start_cpanel_update":{"paths":{"/start_cpanel_update":{"get":{"operationId":"start_cpanel_update","description":"This function starts an update of cPanel & WHM.","parameters":[{"required":"false","in":"query","name":"mode","schema":{"nullable":"true","enum":["force","sync"],"example":"force","default":null,"type":"string"},"description":"The cPanel & WHM update’s mode of operation.\n\n* null — Only reinstall cPanel & WHM if a newer version is available.\n* `force`   — Force a reinstall of cPanel & WHM, even if the system is up to date.\n* `sync`    — Update the currently-installed version of cPanel & WHM instead of downloading\na newer version. This ensures the current version installed has the correct files."}],"x-cpanel-available-version":"94","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"start_cpanel_update","description":"The method name called."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"log_path":{"format":"path","description":"The filesystem path to the update process’s log file.","example":"/var/cpanel/updatelogs/update.1604521159.log","type":"string"},"is_new":{"example":"1","enum":["1","0"],"description":"Whether the update process started as a result of this request.\n\n* `1` — The update process started as a result of this request.\n* `0` — The update process existed prior to this request.","type":"integer"},"pid":{"type":"integer","minimum":"2","description":"The update process’s ID.","example":"23456"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 start_cpanel_update"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/start_cpanel_update?api.version=1"}],"tags":["Server Administration","Updates"],"summary":"Start cPanel & WHM update","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Updates"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Updates","name":"Updates"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"description":"WHM API.","version":"11.93.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"ticket_ssh_test_start":{"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"description":"cPanel Support Tickets / Support Access","name":"Support Access"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"cPanel Support Tickets","tags":["Support Access"]}],"paths":{"/ticket_ssh_test_start":{"get":{"parameters":[{"description":"The support ticket number that other functions can use to query or make additional changes to the support ticket.","schema":{"example":"7648492","type":"integer"},"in":"query","name":"ticket_id","required":"true"},{"schema":{"minimum":"1","type":"integer","example":"1"},"description":"An integer that represents the ticket's actionable server. Increment the value by one for each server in the support ticket.","required":"true","name":"server_num","in":"query"}],"operationId":"ticket_ssh_test_start","description":"This function initiates an SSH connection test.\n\n**Important:**\n\nThis function is **not** available through the command line. You **must** call it\nas a request body.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"description":"The method name called.","example":"ticket_ssh_test_start","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"type":"object","properties":{}}},"type":"object"}}}}},"x-cpanel-available-version":"60","x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_ssh_test_start?api.version=1&ticket_id=7648492&server_num=1"}],"tags":["Support Tickets","Support Access"],"summary":"Validate Support SSH connection","x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"false"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"twofactorauth_get_issuer":{"paths":{"/twofactorauth_get_issuer":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"system_wide_issuer":{"description":"The system's default issuer's name.\n\n**Note:**\n\nIf the `root` user has **not** configured a system-wide issuer, this value defaults to the system hostname.","example":"example.cpanel.net","type":"string"},"issuer":{"type":"string","example":"example.cpanel.net","description":"The issuer's name for the currently-authenticated user."}},"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"twofactorauth_get_issuer","description":"The method name called."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"54","parameters":[],"operationId":"twofactorauth_get_issuer","description":"This function returns the currently configured issuer. The issuer appears within the authentication app.","summary":"Return configured issuer for current user","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_get_issuer\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_get_issuer?api.version=1"}],"tags":["Authentication","Two-Factor Authentication"]}}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"Two-Factor Authentication","description":"Authentication / Two-Factor Authentication"}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"update_updateconf":{"paths":{"/update_updateconf":{"post":{"operationId":"update_updateconf","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.","parameters":[{"in":"query","name":"CPANEL","required":"false","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.","schema":{"example":"RELEASE","anyOf":[{"enum":["STABLE","RELEASE","CURRENT","EDGE","LTS"],"type":"string"},{"format":"cPanel version","type":"string"},{"type":"string"}]}},{"in":"query","name":"RPMUP","required":"false","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.","schema":{"anyOf":[{"type":"string","enum":["daily","manual","never"]},{"type":"string"}],"example":"daily"}},{"in":"query","name":"SARULESUP","required":"false","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.","schema":{"anyOf":[{"type":"string","enum":["daily","manual","never"]},{"type":"string"}],"example":"daily"}},{"required":"false","name":"UPDATES","in":"query","schema":{"anyOf":[{"type":"string","enum":["daily","manual","never"]},{"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."},{"schema":{"example":"/usr/local/cpanel","type":"string"},"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.","required":"false","name":"STAGING_DIR","in":"query"}],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"update_updateconf","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}}}},"tags":["Updates"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_updateconf\n","label":"CLI","lang":"Shell"},{"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","summary":"Update software update behavior"}}},"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"link_server_node_with_api_token":{"paths":{"/link_server_node_with_api_token":{"get":{"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.","schema":{"example":"example","minLength":"1","type":"string","maxLength":"50"},"name":"alias","in":"query","required":"true"},{"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.","schema":{"type":"string","example":"23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H"},"name":"api_token","in":"query","required":"true"},{"description":"The remote server node's hostname.\n\n**Note:**\n\nThis parameter does **not** accept an IP address.","schema":{"type":"string","format":"hostname","example":"host.example.com"},"in":"query","name":"hostname","required":"true"},{"in":"query","name":"username","required":"true","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.","schema":{"type":"string","format":"username","example":"root"}},{"schema":{"example":"0","enum":["1","0"],"default":"0","type":"integer"},"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.","required":"false","name":"skip_tls_verification","in":"query"}],"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","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"command":{"description":"The method name called.","example":"link_server_node_with_api_token","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86","x-codeSamples":[{"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":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","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"}],"tags":["Server Administration","Server Nodes"],"summary":"Add linked server node","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Server Nodes"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Server Nodes","name":"Server Nodes"}],"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"setresellerlimits":{"paths":{"/setresellerlimits":{"get":{"tags":["Resellers","Account Limits"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  setresellerlimits \\\n  user='username'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellerlimits?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","summary":"Update reseller's bandwidth and disk quotas","description":"This function sets a reseller's bandwidth and disk quotas.","operationId":"setresellerlimits","parameters":[{"in":"query","name":"user","required":"true","description":"The reseller's username.","schema":{"type":"string","format":"username","example":"username"}},{"schema":{"type":"integer","default":"0","example":"0","enum":["1","0"]},"description":"Whether to limit the reseller's total number of accounts.\n\n* `1` — Limit.\n* `0` — Do **not** limit.\n\n**Note:**\n\nUse this parameter with the `account_limit` parameter.","required":"false","in":"query","name":"enable_account_limit"},{"required":"false","name":"account_limit","in":"query","schema":{"type":"integer","minimum":"1","example":"10"},"description":"The reseller's maximum total number of accounts.\n\n**Important:**\n\nThe system **only** enforces this maximum if you set the `enable_account_limit`\nvalue to `1`."},{"name":"enable_resource_limits","in":"query","required":"false","description":"Whether to limit the reseller's resources.\n\n* `1` — Limit resources.\n* `0` — Do **not** limit resources.\n\n**Note:**\n\nUse this parameter with the `bandwidthlimit`, `diskspace_limit`,\n`enable_overselling`, `enable_overselling_bandwidth`, `enable_overselling_diskspace`,\n`enable_overselling`, `enable_package_limits`, and `enable_package_limit_numbers`\nparameters.","schema":{"enum":["1","0"],"example":"1","default":"0","type":"integer"}},{"description":"The reseller's total bandwidth limit.\n\n**Important:**\n\nThe system **only** enforces this limit if you set the `enable_resource_limits`\nvalue to `1`.","schema":{"minimum":"0","type":"integer","example":"1073741824","format":"megabytes"},"name":"bandwidth_limit","in":"query","required":"false"},{"required":"false","name":"enable_overselling","in":"query","schema":{"enum":["1","0"],"example":"1","type":"integer"},"description":"Whether the reseller can oversell accounts.\n\n* `1` — The reseller can oversell accounts.\n* `0` — The reseller **cannot** oversell accounts.\n\n**Important:**\n\nThe system **only** enforces this limit if you set the `enable_resource_limits`\nvalue to `1`."},{"name":"enable_overselling_bandwidth","in":"query","required":"false","description":"Whether the reseller can oversell bandwidth.\n\n* `1` — The reseller can oversell bandwidth.\n* `0` — The reseller **cannot** oversell bandwidth.\n\n**Important:**\n\nThe system **only** enforces this limit if you set the `enable_resource_limits` and\nthe `enable_overselling` values to `1`.","schema":{"enum":["1","0"],"example":"1","type":"integer"}},{"schema":{"type":"integer","enum":["1","0"],"example":"1"},"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.\n\n**Important:**\n\nThe system **only** enforces this limit if you set the `enable_resource_limits`\nand the `enable_oversellng` values to `1`.","required":"false","name":"enable_overselling_diskspace","in":"query"},{"required":"false","in":"query","name":"diskspace_limit","schema":{"minimum":"0","type":"integer","example":"1073741824","format":"megabytes"},"description":"The reseller's total disk space usage limit.\n\n**Important:**\n\nThe system **only** enforces this limit if you set the `enable_resource_limits`\nvalue to `1`."},{"description":"Whether to apply package limits to the reseller.\n\n* `1` — Enable package limits.\n* `0` — Disable package limits.","schema":{"enum":["1","0"],"example":"0","type":"integer"},"in":"query","name":"enable_package_limits","required":"false"},{"description":"Whether to apply package limit numbers to the reseller.\n\n* `1` — Enable package limit numbers.\n* `0` — Disable package limit numbers.","schema":{"type":"integer","enum":["1","0"],"example":"0"},"name":"enable_package_limit_numbers","in":"query","required":"false"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"example":"setresellerlimits","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"tags":["Account Limits"],"name":"Resellers"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"description":"Resellers / Account Limits","name":"Account Limits"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"delete_configclusterserver":{"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/delete_configclusterserver":{"get":{"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"name":{"description":"The remote configuration cluster server's name.","example":"example.com","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"delete_configclusterserver","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"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.","schema":{"example":"example.com","type":"string"},"name":"name","in":"query","required":"true"}],"summary":"Delete server from configuration cluster","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_configclusterserver \\\n  name='example.com'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_configclusterserver?api.version=1&name=example.com"}],"tags":["Server Administration","Configuration Clusters"]}}},"x-tagGroups":[{"tags":["Configuration Clusters"],"name":"Server Administration"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Configuration Clusters","description":"Server Administration / Configuration Clusters"}]},"resetzone":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2","x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"paths":{"/resetzone":{"get":{"tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  resetzone\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/resetzone?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Restore DNS zone to default values","parameters":[{"description":"The domain.","schema":{"type":"string","format":"domain","example":"example.com"},"name":"domain","in":"query","required":"false"},{"name":"zone","in":"query","required":"false","description":"The zone file.","schema":{"example":"example.com.db","type":"string"}},{"description":"The domain's owner.","schema":{"type":"string","format":"username","example":"user"},"in":"query","name":"user","required":"false"}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","example":"resetzone","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason `field for more details."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"description":"DNS / Domain Management","name":"Domain Management"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"batch_create_cphulk_records":{"components":{"schemas":{"ip-address":{"anyOf":[{"example":"192.168.0.1","format":"ipv4","type":"string"},{"format":"cidr","example":"192.168.0.1/30","type":"string"},{"type":"string","format":"ipv4-ipv4","example":"192.168.0.1-192.168.0.2"},{"type":"string","format":"ipv6","example":"2001:db8::"},{"format":"cidr","example":"2001:db8::/32","type":"string"},{"example":"2001:0db8::-2001:0db8:ffff:ffff:ffff:ffff:ffff:ffff","format":"ipv6-ipv6","type":"string"}]}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"name":"Management","description":"Login Security (cPHulk) / Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Management"]}],"paths":{"/batch_create_cphulk_records":{"post":{"x-codeSamples":[{"source":"echo '{\"api.version\":\"1\",\"list_name\":\"white\",\"records\":[{\"comment\":\"Automated update tools.\",\"ip\":\"192.168.0.1\"},{\"comment\":\"System administrators and support systems.\",\"ip\":\"192.168.1.1/30\"},{\"comment\":\"Owner of example.com.\",\"ip\":\"122.1.56.7-122.1.56.8\"}]}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n  batch_create_cphulk_records","label":"CLI","lang":"Shell"},{"source":"POST /cpsess##########/json-api/batch_create_cphulk_records HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 260\n\n{\"api.version\":\"1\",\"list_name\":\"white\",\"records\":[{\"comment\":\"Automated update tools.\",\"ip\":\"192.168.0.1\"},{\"comment\":\"System administrators and support systems.\",\"ip\":\"192.168.1.1/30\"},{\"comment\":\"Owner of example.com.\",\"ip\":\"122.1.56.7-122.1.56.8\"}]}","lang":"HTTP","label":"HTTP Request (Wire Format)"}],"tags":["cPHulk","Management"],"requestBody":{"content":{"application/json":{"schema":{"example":{"records":[{"comment":"Automated update tools.","ip":"192.168.0.1"},{"comment":"System administrators and support systems.","ip":"192.168.1.0/30"},{"comment":"Owner of example.com.","ip":"122.1.56.7-122.1.56.8"},{"ip":"2001:db9::","comment":"Special access group 1"},{"ip":"2001:db9::1-2001:db9::5","comment":"Special access group 1"},{"ip":"2001:db8::/32","comment":"Special access group 2"}],"api.version":"1","list_name":"white"},"required":["api.version","list_name","records"],"properties":{"api.version":{"enum":["1"],"description":"The WHM API version number.","type":"integer"},"records":{"type":"array","items":{"properties":{"comment":{"maximum":"255","type":"string","example":"Dangerous website"},"ip":{"$ref":"#/components/schemas/ip-address"}},"type":"object","required":["ip"],"description":"A whitelist or blacklist record."},"description":"The list of records to add to the whitelist or blacklist."},"skip_enabled_check":{"enum":["0","1"],"example":"1","description":"Whether to skip checking if cPHulk runs on the server.\n\n* `1` - Do **not** check if cPHulk is running.\n* `0` - Check if cPHulk is running.\n\n**Note:**\n\n If cPHulk is disabled and you check its status, the function returns the following message: `cPHulk is disabled on the server.` ","default":"0","type":"integer"},"list_name":{"type":"string","example":"white","enum":["black","white"],"description":"The cPHulk list's name.\n\n* `black` - Add a new record or records to the blacklist.\n* `white` - Add a new record or records to the whitelist. "}}}}}},"summary":"Add login security record to list with comment","x-cpanel-api-version":"WHM API 1","description":"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.","operationId":"batch_create_cphulk_records","x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"batch_create_cphulk_records","type":"string"}}},"data":{"properties":{"requester_ip":{"description":"The IP address of the user or system that requested the addition.","example":"10.1.4.228","anyOf":[{"format":"ipv4","type":"string"},{"type":"string","format":"ipv6"}]},"ips_added":{"description":"An array of IP addresses that the function added from the list. This function will always returns ranges in the IP1-IP2 format.","items":{"$ref":"#/components/schemas/ip-address"},"example":["192.168.0.1","192.168.1.0-192.168.1.3","122.1.56.7-122.1.56.8"],"type":"array"},"ips_failed":{"type":"object","additionalProperties":{"type":"string","description":"The reason why the system failed to add an IP address to the list.\n\n**Note:**\n\nThe IP address is the return's name."},"example":{"192.168.0.1":"Invalid IP address or range: \"192.68.0.1\""},"description":"An object of IP addresses that the system failed to add to the list. This object contains one or more IP address returns."},"requester_ip_is_whitelisted":{"type":"integer","description":"Whether the requester's IP address exists on cPHulk's whitelist.\n* `1` - Whitelisted.\n* `0` - Not whitelisted.","enum":["0","1"],"example":"0"},"ip_blocks_removed":{"description":"The number of IP address blocks that the function deleted.","example":"1","type":"integer"},"list_name":{"example":"white","enum":["black","white"],"description":"The cPHulk list's name.\n* `black`\n* `white`","type":"string"},"comment":{"type":"string","example":"George Wendt flying through the air.","description":"The comment that you included when you called the function."},"iptable_bans_removed":{"description":"The number of `iptables` temporary block rules that the function deleted.","example":"0","minimum":"0","type":"integer"},"original_ips_added":{"type":"array","example":["192.168.0.1","192.168.1.0/30","122.1.56.7-122.1.56.8"],"description":"An array of IP addresses that the function added from the list.\n  The system will return the one of the following formats:\n\n - A IPv4 address (192.168.0.1).\n - A simple IPv4 address range (192.168.1.1-192.168.1.4).\n - A CIDR IPv4 address range (192.168.1.0/30).","items":{"$ref":"#/components/schemas/ip-address"}}},"type":"object"}},"type":"object"}}}}}}}}},"remove_connected_application":{"x-tagGroups":[{"tags":["Connected Applications"],"name":"Server Administration"}],"paths":{"/remove_connected_application":{"post":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remove_connected_application \\\n  name='application-1'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_connected_application?api.version=1&name=application-1","label":"URL","lang":"HTTP"}],"tags":["Server Administration","Connected Applications"],"summary":"Remove application connection information","x-cpanel-api-version":"WHM API 1","operationId":"remove_connected_application","description":"Remove the connected application from the server. This only removes the connection\ninformation from the configuration file. It does not clean up any allocated\nresources, such as API tokens and public/private keys. Any tokens or keys need to be\nremoved from the system separately.","parameters":[{"description":"The name of the connected application.","schema":{"type":"string","example":"application-1"},"name":"name","in":"query","required":"true"}],"x-cpanel-available-version":"98","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"remove_connected_application","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}}}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Connected Applications","name":"Connected Applications"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.98.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"ea4_save_profile":{"tags":[{"description":"The EasyApache module for WHM API 1.","name":"EasyApache"},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Web Server Configuration","tags":["EasyApache Settings"]}],"paths":{"/ea4_save_profile":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"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","label":"URL","lang":"HTTP"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"path":{"type":"string","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"},"already_exists":{"type":"integer","enum":["0","1"],"example":"1","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."}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"ea4_save_profile","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}}}},"x-cpanel-available-version":"64","parameters":[{"required":"true","name":"filename","in":"query","schema":{"example":"new_profile.json","type":"string"},"description":"The profile's file name."},{"description":"The profile's display name.","schema":{"type":"string","example":"New Profile"},"name":"name","in":"query","required":"true"},{"explode":"true","schema":{"example":["ea-apache24","ea-apache24-foo"],"items":{"type":"string"},"type":"array"},"required":"true","name":"pkg","in":"query","description":"The packages that the profile contains.","style":"form"},{"description":"The description of the profile.","schema":{"default":"","example":"This is my new profile.","type":"string"},"name":"desc","in":"query","required":"false"},{"required":"false","name":"version","in":"query","schema":{"type":"string","default":"0","example":"1.3"},"description":"The profile's version number."},{"name":"tag","in":"query","required":"false","style":"form","description":"Tags that are appropriate for the profile.","explode":"true","schema":{"items":{"type":"string"},"default":[],"example":["Apache 2.4","Optimized for static content"],"type":"array"}},{"schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to overwrite the file, if it exists.\n\n* `1` — Overwrite the file.\n* `0` — Do **not** overwrite the file.","required":"false","in":"query","name":"overwrite"}],"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"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"set_cphulk_config_key":{"paths":{"/set_cphulk_config_key":{"get":{"summary":"Update login security configuration settings","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_cphulk_config_key key=is_enabled value=1\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_cphulk_config_key?api.version=1&key=is_enabled&value=1","lang":"HTTP","label":"URL"}],"tags":["cPHulk","Settings"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"set_cphulk_config_key"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"properties":{"cphulk_config":{"description":"cPHulk configuration settings.","type":"object","properties":{"is_enabled":{"type":"integer","description":"Whether the cPHulk service is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":["0","1"],"example":"1"},"can_temp_ban_firewall":{"description":"Whether the system firewall can apply temporary IP address bans.\n* `1` - Can temporarily apply IP address bans.\n* `0` - Cannot temporarily apply IP address bans.\n\n**Note:**\n\nIf this return's value is 0, then the `ip_based_protection parameter` is **not** available, which means that you cannot use the following parameters:\n* `block_brute_force_with_firewall`\n* `block_excessive_brute_force_with_firewall`\n* `ip_brute_force_period_mins`\n* `ip_brute_force_period_sec`","enum":["0","1"],"example":"1","type":"integer"},"command_to_run_on_brute_force":{"description":"The command to run when an IP address triggers brute force protection.\n- A valid command.\n- An empty string.","example":"","type":"string"},"country_whitelist":{"example":"US,AU","format":"ISO-3166-1 (alpha-2)","description":"The countries to whitelist. A comma-separated list of valid ISO 3166-1 alpha-2 country codes. This value may be empty.","type":"string"},"command_to_run_on_excessive_brute_force":{"type":"string","description":"The command to run when the system blocks an IP address blocked for a one day period.\n* A valid command.\n* An empty string.","example":""},"max_failures":{"example":"30","description":"The maximum number of failures that cPHulk allows per account within the defined time range.","type":"integer"},"lookback_time":{"type":"integer","example":"21600","description":"The number of seconds over which cPHulk counts failed logins against a user."},"username_based_protection":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether username-based protection on all requests is enabled.\n* `1` - Enabled.\n* `0` - Disabled."},"notify_on_root_login_for_known_netblock":{"description":"Whether cPHulk sends a notification upon successful root login when the IP address is **not** on the whitelist, but from a known netblock\n* `1` - Send the notification.\n* `0` - Do **not** send the notification.","example":"0","enum":["0","1"],"type":"integer"},"max_failures_byip":{"description":"The maximum number of failures from a specific IP address before cPHulk locks out that address.","example":"5","type":"integer"},"ip_brute_force_period_mins":{"description":"The number of minutes in which cPHulk measures an attacker's login attempts.","example":"15","type":"integer"},"notify_on_brute":{"type":"integer","description":"Whether cPHulk will send a notification when it detects a brute force attack.\n* `1` - Send the notification.\n* `0` - Do **not** send the notification.","enum":["0","1"],"example":"0"},"block_excessive_brute_force_with_firewall":{"description":"Whether to use cPanel & WHM's firewall to block excessive brute force attacks.\n* `1` - Use the firewall.\n* `0` - Do **not** use the firewall.","example":"0","enum":["0","1"],"type":"integer"},"username_based_protection_local_origin":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether username-based protection only on requests that originate from a local IP address.\n* `1` - Enabled.\n* `0` - Disabled."},"mark_as_brute":{"example":"30","description":"The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.","type":"integer"},"block_brute_force_with_firewall":{"description":"Whether to use cPanel & WHM's firewall to block brute force attacks.\n* `1` - Use the firewall.\n* `0` - Do **not** use the firewall.","enum":["0","1"],"example":"0","type":"integer"},"username_based_protection_for_root":{"description":"Whether username-based protection can lock out the root user.\n* `1` - Allowed.\n* `0` - Not allowed.","example":"0","enum":["0","1"],"type":"integer"},"brute_force_period_sec":{"type":"integer","description":"The number of seconds over which cPHulk measures all login attempts to a specific user's account.","example":"300"},"notify_on_root_login":{"type":"integer","description":"Whether cPHulk will send a notification when the root user successfully logs in from an IP address that is **not** on the whitelist.\n* `1` - Send the notification.\n* `0` - Do **not** send the notification.","example":"0","enum":["0","1"]},"country_blacklist":{"description":"The countries to blacklist. A comma-separated list of valid ISO 3166-1 alpha-2 country codes. This value may be empty.","format":"ISO-3166-1 (alpha-2)","example":"PK,BR","type":"string"},"ip_brute_force_period_sec":{"type":"integer","example":"900","description":"The number of seconds in which cPHulk measures an attacker's login attempts."},"brute_force_period_mins":{"type":"integer","description":"The number of minutes over which cPHulk measures all login attempts to a specific user's account.","example":"5"},"ip_based_protection":{"enum":["0","1"],"example":"1","description":"Whether IP address-based protection on all requests is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","type":"integer"},"lookback_period_min":{"type":"integer","example":"360","description":"The number of minutes over which cPHulk counts failed logins against a user."}}}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"70","parameters":[{"required":"true","in":"query","name":"key","schema":{"enum":["block_brute_force_with_firewall","block_excessive_brute_force_with_firewall","brute_force_period_mins","brute_force_period_sec","command_to_run_on_brute_force","command_to_run_on_excessive_brute_force","country_blacklist","country_whitelist","ip_based_protection","ip_brute_force_period_mins","ip_brute_force_period_sec","is_enabled","lookback_period_min","lookback_time","mark_as_brute","max_failures","max_failures_byip","notify_on_brute","notify_on_root_login","notify_on_root_login_for_known_netblock","username_based_protection","username_based_protection_for_root","username_based_protection_local_origin"],"example":"is_enabled","type":"string"},"description":"The configuration key for the setting to set/modify.\n\nIt should be one of the following:\n*  `block_brute_force_with_firewall` - Whether to use cPanel & WHM's firewall to block brute force attacks.\n*  `block_excessive_brute_force_with_firewall` - Whether to use cPanel & WHM's firewall to block excessive brute force attacks.\n*  `brute_force_period_mins` - The number of minutes over which cPHulk measures all login attempts to a specific user's account.\n*  `brute_force_period_sec` - The number of seconds over which cPHulk measures all login attempts to a specific user's account.\n*  `command_to_run_on_brute_force` - The command to run when an IP address triggers brute force protection.\n*  `command_to_run_on_excessive_brute_force` - The command to run when the system blocks an IP address blocked for a one day period.\n*  `country_blacklist` - The countries to blacklist.\n*  `country_whitelist` - The countries to whitelist.\n*  `ip_based_protection` - Whether to enable IP address-based protection on all requests.\n*  `ip_brute_force_period_mins` - The number of minutes in which cPHulk measures an attacker's login attempts.\n*  `ip_brute_force_period_sec` - The number of seconds in which cPHulk measures an attacker's login attempts.\n*  `is_enabled` - Whether to enable the cPHulk service.\n*  `lookback_period_min` - The number of minutes over which cPHulk counts failed logins against a user.\n*  `lookback_time` - The number of seconds over which cPHulk counts failed logins against a user.\n*  `mark_as_brute` - The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.\n*  `max_failures` - The maximum number of failures that cPHulk allows per account within the defined time range.\n*  `max_failures_byip` - The maximum number of failures from a specific IP address before cPHulk locks out that address.\n*  `notify_on_brute` - Whether cPHulk will send a notification when it detects a brute force attack.\n*  `notify_on_root_login` - Whether cPHulk will send a notification when the root user successfully logs in from an IP address that is **not** on the whitelist.\n*  `notify_on_root_login_for_known_netblock` - Whether cPHulk sends a notification upon successful root login when the IP address is **not** on the whitelist, but from a known netblock.\n*  `username_based_protection` - Whether to enable username-based protection on all requests.\n*  `username_based_protection_for_root` - Whether to allow username-based protection to lock out the root user.\n*  `username_based_protection_local_origin` - Whether to enable username-based protection only on requests that originate from a local IP address."},{"description":"The new value for the specified key. The allowable value depends on which key is being set.\n\nFor the following keys, the value must be 0 or 1:\n* `block_brute_force_with_firewall`\n* `block_excessive_brute_force_with_firewall`\n* `ip_based_protection`\n* `is_enabled`\n* `notify_on_brute`\n* `notify_on_root_login`\n* `notify_on_root_login_for_known_netblock`\n* `username_based_protection`\n* `username_based_protection_for_root`\n* `username_based_protection_local_origin`\n\nFor the following keys, the value must be an integer which specifies a number of minutes or seconds:\n* `brute_force_period_mins`\n* `brute_force_period_sec`\n* `ip_brute_force_period_mins`\n* `ip_brute_force_period_sec`\n* `lookback_period_min`\n* `lookback_time` - This one is in seconds despite not having `sec` in the name\n\nThese keys require the value to be a string containing a command to be run:\n(For a list of commands, read the _Command Variables_ section of our [cPHulk Brute Force Protection](https://go.cpanel.net/whmdocscPHulkBruteForceProtection) documentation.)\n* `command_to_run_on_brute_force`\n* `command_to_run_on_excessive_brute_force`\n\nThese keys require the value to be a string containing a comma-separated list of country codes:\n(For a list of countries, run the WHM API 1 `get_countries_with_known_ip_ranges` function.)\n* `country_blacklist`\n* `country_whitelist`\n\nThe following keys require an integer representing a maximum number of failures\n* `mark_as_brute`\n* `max_failures`\n* `max_failures_byip`","schema":{"oneOf":[{"type":"string"},{"type":"integer"}],"example":"1"},"in":"query","name":"value","required":"true"}],"operationId":"set_cphulk_config_key","description":"This function modifies a single cPHulk configuration settings as specified."}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Settings"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Settings","name":"Settings"}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"fetch_pkgacct_master_log":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/fetch_pkgacct_master_log":{"get":{"x-cpanel-available-version":"88","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"fetch_pkgacct_master_log","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"log":{"type":"string","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/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\"}","description":"The master log file's contents."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function returns the contents of a `start_background_pkgacct` session's master log file.","operationId":"fetch_pkgacct_master_log","parameters":[{"name":"session_id","in":"query","required":"true","description":"The `start_background_pkgacct` session ID.","schema":{"example":"username20200323154328kDJ2Kx4xua2KtG","type":"string"}}],"x-cpanel-api-version":"WHM API 1","summary":"Return start_background_pkgacct session log file","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetch_pkgacct_master_log \\\n  session_id='username20200323154328kDJ2Kx4xua2KtG'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_pkgacct_master_log?api.version=1&session_id=username20200323154328kDJ2Kx4xua2KtG"}]}}},"x-tagGroups":[{"name":"Backups","tags":["Backup or Restore"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}]},"package_manager_fixcache":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"tags":["Package Manager Settings"],"name":"System Package Management"}],"paths":{"/package_manager_fixcache":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","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.","example":"1","enum":["1"],"type":"integer"}},"type":"object"},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"package_manager_fixcache","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"64","parameters":[],"description":"This function attempts to repair yum cache issues.","operationId":"package_manager_fixcache","x-cpanel-api-version":"WHM API 1","summary":"Repair RPM management yum cache issues","tags":["RPM","Package Manager Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_fixcache\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_fixcache?api.version=1"}]}}},"tags":[{"description":"The RPM module for WHM API 1.","name":"RPM"},{"name":"Package Manager Settings","description":"System Package Management / Package Manager Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}]},"purchase_a_trial":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"version":"11.91.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/purchase_a_trial":{"post":{"description":"This function retrieves and installs a trial license from the cPanel Store or a compatible cPanel Market provider.","operationId":"purchase_a_trial","x-cpanel-internal-only":"true","x-cpanel-available-version":"90.0","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"licensed_ip":{"example":"192.0.2.0","description":"The licensed IP address.","format":"ipv4","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"command":{"example":"purchase_a_trial","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"- 1 - Success.\n- 0 - Failed. Check the reason field for more details."}}}},"type":"object"}}}}},"tags":["License Management"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"api.version":{"type":"number","description":"The targeted version of the WHM API.\n\n**Note:**\n\n`1` is the only possible value.","enum":["1"],"example":"1"},"checkout_args":{"example":{"send_verification":"1"},"description":"An object of arguments to send to the provider's checkout method. The specific arguments required, if any, will be specific to each provider.","type":"object","additionalProperties":"true"},"login_token":{"type":"string","description":"The login token to access the cPanel Store or cPanel Market provider.","example":"1a676e6f-99fc-11e6-9ab6-e60a769b73bc"},"provider":{"example":"cPStore","description":"The cPanel Store or cPanel Market provider's namespace.","type":"string"}},"required":["api.version","provider","login_token"],"type":"object"}}},"required":"true"},"x-codeSamples":[{"source":"echo '{\"api.version\":\"1\",\"checkout_args\":{\"send_verification\":\"1\"},\"login_token\":\"1a676e6f-99fc-11e6-9ab6-e60a769b73bc\",\"provider\":\"cPStore\"}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n  purchase_a_trial","label":"CLI","lang":"Shell"},{"source":"POST /cpsess##########/json-api/purchase_a_trial HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 135\n\n{\"api.version\":\"1\",\"checkout_args\":{\"send_verification\":\"1\"},\"login_token\":\"1a676e6f-99fc-11e6-9ab6-e60a769b73bc\",\"provider\":\"cPStore\"}","lang":"HTTP","label":"HTTP Request (Wire Format)"}],"x-cpanel-api-version":"WHM API 1","summary":"Purchase a trial"}}},"x-tagGroups":[{"tags":["License Management"],"name":"Server Administration"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"License Management"}]},"api_token_create":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"API Token Management","description":"API Development Tools / API Token Management"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["API Token Management"],"name":"API Development Tools"}],"paths":{"/api_token_create":{"get":{"parameters":[{"description":"The API token's name.\n\n**Note:**\n\n* An API token name's maximum length is 50 characters, and the name may **only**\ncontain alphanumeric characters, dashes (`-`), and underscores (`_`).\n* You **must** assign a name that does **not** already exist to the API token.","schema":{"example":"example","type":"string"},"name":"token_name","in":"query","required":"true"},{"schema":{"type":"string"},"description":"The privileges to assign to the token. If you do not use this parameter, the system\nassigns **all** of your privileges to the token.\n\n**Note:**\n\n* You can **only** assign privileges that you possess to the API token.\n* To assign multiple privileges to the token, increment the parameter name. For\nexample: `acl-0`, `acl-1`, `acl-2`.","examples":{"multiple":{"summary":"Assign multiple privileges.","value":"acl-0=create-acct acl-1=list-accts acl-2=kill-acct"},"single":{"summary":"Assign a single privilege.","value":"all"}},"required":"false","name":"acl","in":"query"},{"schema":{"anyOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"},{"format":"cidr","type":"string"}]},"examples":{"multiple":{"summary":"Assign multiple IP or CIDR ranges.","value":"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"},"single":{"summary":"Assign a single IP or CIDR range.","value":"192.0.2.8/29"}},"description":"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\ndoes not limit which IPs can use this token.\n\n**Note:**\n\n* To assign multiple whitelisted IPs to the token, increment the parameter name. For\nexample: `whitelist_ip-0`, `whitelist_ip-1`, `whitelist_ip-2`.","required":"false","in":"query","name":"whitelist_ip"},{"name":"expires_at","in":"query","required":"false","description":"The API token's expiration time. If you do not use this parameter, the\nAPI token will not expire.\n\n* A date, in [Unix Epoch format](http://en.wikipedia.org/wiki/Unix_time).\n* `0` — The API token will **not** expire.\n\n**Important:**\n\n When an API token expires, the system **does** not delete it. You **must**\n manually delete expired API tokens.","schema":{"type":"integer","example":"1609372800","default":"0"}}],"description":"This function creates an API token. You can use API tokens instead of a password\nor access hash key to execute WHM API 1 functions over HTTPS. For more information\nabout API tokens, read our\n[Manage API Tokens in WHM](https://docs.cpanel.net/whm/development/manage-api-tokens-in-whm/)\ndocumentation.\n\n**Important:**\n\nYou **must** call this function over an SSL connection.","operationId":"api_token_create","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"expires_at":{"type":"integer","format":"unix_timestamp","description":"The API token's expiration time.\n\n* A valid timestamp, in Unix time format.\n* A `null` value.","example":"1609372800","nullable":"true"},"create_time":{"type":"integer","format":"unix_timestamp","description":"The API token's creation time, in Unix time format.","example":"1483625276"},"acls":{"items":{"type":"string","example":"kill-acct"},"description":"An array of privileges that the token possesses.","type":"array"},"token":{"type":"string","description":"The new API token to use to authenticate to WHM.\n\n**Warning:**\n\nMake **certain** that you save your API token in a safe location.\nYou **cannot** access the token again after you use this function.","example":"UWU28DCA23NKY76CN17MDPKM3O7EFQY8"},"whitelist_ips":{"type":"array","description":"List of remote IP or CIDR IP ranges this token may be used from.","items":{"anyOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"},{"format":"cidr","type":"string"}]},"example":["1.1.1.1","1.1.1.2","1.1.1.8/29","fc00:abcd:0000:0000:0000:0000:0000:000f","2620:0000:28a4:0000:0000:0000:0000:0000/48"],"nullable":"true"},"name":{"description":"The new API token's name.\n\n**Note:**\n\nUse this value to revoke an API token with WHM API 1's\n`api_token_revoke` function.","example":"example","type":"string"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"api_token_create","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"64","tags":["Authentication","API Token Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  api_token_create \\\n  token_name='example'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/api_token_create?api.version=1&token_name=example"}],"x-cpanel-api-version":"WHM API 1","summary":"Create WHM API token"}}}},"modsec_remove_rule":{"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_remove_rule":{"get":{"x-cpanel-available-version":"11.46","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_remove_rule","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"modsec_remove_rule","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.","parameters":[{"required":"true","in":"query","name":"config","schema":{"example":"modsec_vendor_configs/example.conf","type":"string"},"description":"The ModSecurity configuration file's path and filename, relative to the `/usr/local/apache/conf/` directory."},{"schema":{"minimum":"1","type":"integer","example":"1234567890"},"description":"The rule's ID.","required":"true","in":"query","name":"id"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_remove_rule \\\n  config='modsec_vendor_configs/example.conf' \\\n  id='1234567890'\n","label":"CLI","lang":"Shell"},{"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"}]}}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2"},"remote_mysql_validate_profile":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/remote_mysql_validate_profile":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_validate_profile \\\n  name='MyProfile'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_validate_profile?api.version=1&name=MyProfile","label":"URL","lang":"HTTP"}],"tags":["Databases","Remote MySQL Databases"],"summary":"Validate remote MySQL profile connection","x-cpanel-api-version":"WHM API 1","operationId":"remote_mysql_validate_profile","description":"This function validates a specified remote MySQL® profile's connection details.","parameters":[{"description":"The profile's name.","schema":{"example":"MyProfile","type":"string"},"name":"name","in":"query","required":"true"}],"x-cpanel-available-version":"11.52","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profile_validated":{"example":"MyProfile","description":"The validated profile's name.","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"example":"remote_mysql_validate_profile","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"name":"Databases","tags":["Remote MySQL Databases"]}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"Remote MySQL Databases","description":"Databases / Remote MySQL Databases"}]},"unsetupreseller":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"name":"Reseller Account Management","description":"Resellers / Account Management"}],"paths":{"/unsetupreseller":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"unsetupreseller","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function revokes reseller status from an account.","operationId":"unsetupreseller","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","format":"username","example":"username"},"description":"The reseller account's username."}],"x-cpanel-api-version":"WHM API 1","summary":"Disables cPanel account's reseller status","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  unsetupreseller \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unsetupreseller?api.version=1&user=username"}]}}},"x-tagGroups":[{"tags":["Reseller Account Management"],"name":"Resellers"}]},"ipv6_range_remove":{"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"name":"IPv6 Address Settings","description":"IP Address Management / IPv6 Address Settings"}],"paths":{"/ipv6_range_remove":{"get":{"x-cpanel-available-version":"11.40","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"ipv6_range_remove","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"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":[{"required":"true","in":"query","name":"name","schema":{"type":"string","example":"Range1"},"description":"The IPv6 address range's name."}],"summary":"Remove IPv6 address range","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ipv6_range_remove \\\n  name='Range1'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_remove?api.version=1&name=Range1"}],"tags":["IP Addresses","IPv6 Address Settings"]}}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv6 Address Settings"]}],"openapi":"3.0.2","info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"set_provider_client_configurations":{"x-tagGroups":[{"tags":["External Authentication"],"name":"Authentication"}],"paths":{"/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":[{"required":"true","name":"service_name","in":"query","schema":{"type":"string","enum":["cpaneld","whostmgrd","webmaild"],"example":"cpaneld"},"description":"The cPanel & WHM service's name.\n* `cpaneld` — The cPanel daemon.\n* `whostmgrd` — The WHM daemon.\n* `webmaild` — The Webmail daemon."},{"description":"The identity provider's key.","schema":{"example":"cpanelid","type":"string"},"name":"provider_id","in":"query","required":"true"},{"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.","schema":{"example":"{\"client_id\":\"victoria\",\"client_secret\":\"secret\"}","format":"json","type":"string"},"in":"query","name":"configurations","required":"true"}],"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"set_provider_client_configurations","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"tags":["Authentication","External Authentication"],"x-codeSamples":[{"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":"CLI","lang":"Shell"},{"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","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update identity provider client configuration"}}},"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"External Authentication","description":"Authentication / External Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"set_local_mysql_root_password":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Manage MySQL Server"],"name":"Databases"}],"paths":{"/set_local_mysql_root_password":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update MySQL root password","tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  set_local_mysql_root_password \\\n  password='12345luggage'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_local_mysql_root_password?api.version=1&password=12345luggage","label":"URL","lang":"HTTP"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"set_local_mysql_root_password"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"password_reset":{"enum":["0","1"],"example":"1","description":"Whether the system reset the password.\n* `1` — Reset.\n* `0` — **Not** reset.","type":"integer"},"profile_updated":{"enum":["0","1"],"example":"1","description":"Whether the system updated the profile.\n\n**Note:**\n\n This return **only** appears when the *localhost* MySQL profile is active.\n* `1` — Updated.\n* `0` — **Not** updated.","type":"integer"},"configs_updated":{"example":"1","enum":["0","1"],"description":"Whether the system updated the configuration settings.\n\n**Note:**\n\n This return **only** appears when the function includes the `update_config` parameter or when the *localhost* MySQL profile is active.\n* `1` — Updated.\n* `0` — **Not** updated.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.52","parameters":[{"description":"The new MySQL root user's password.","schema":{"type":"string","example":"12345luggage"},"in":"query","name":"password","required":"true"},{"description":"Whether to update the configuration files.\n\n* `1` — Update.\n* `0` — Do **not** update.\n\n**Note:**\n\nThis value is always enabled when *localhost* is the active profile, and must be specified explicitly when a remote profile is active.\n\n**Warning:**\n\nThis parameter updates the `/root/.my.cnf` file with the new password, which could cause problems with the MySQL configuration on the server. If you are unsure, do **not** specify this parameter.\n\n * If you set this parameter to `0` when *localhost* is the active profile, it will stop communication with the remote MySQL server until you update the profile's password.\n * If you set this parameter to `1` when a remote host is the active profile, it will stop communication with the remote MySQL server until you update the profile's password.","schema":{"type":"integer","example":"1","enum":["0","1"]},"in":"query","name":"update_config","required":"false"}],"description":"This function resets the root user's password on the local MySQL® server.\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":"set_local_mysql_root_password"}}},"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"Manage MySQL Server","description":"Databases / Manage MySQL Server"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}]},"export_zone_key":{"x-tagGroups":[{"tags":["DNS Security"],"name":"DNS"}],"paths":{"/export_zone_key":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Export domain's DNSSEC key","tags":["DNS","DNS Security"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  export_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/export_zone_key?api.version=1&domain=example.com&key_id=1"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"key_tag":{"example":"40481","description":"The security key's integer value.","type":"integer"},"key_type":{"type":"string","example":"CSK","description":"The type of security key.\n\n* `CSK` — Combined Signing Key.\n* `KSK` — Key Signing Key.\n* `ZSK` — Zone Signing Key."}}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"export_zone_key"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"86","parameters":[{"required":"true","in":"query","name":"domain","schema":{"example":"example.com","type":"string"},"description":"The domain to export the security key to."},{"required":"true","in":"query","name":"key_id","schema":{"example":"1","type":"integer"},"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."}],"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"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Security","description":"DNS / DNS Security"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"twofactorauth_generate_tfa_config":{"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/twofactorauth_generate_tfa_config":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"secret":{"type":"string","example":"WJ73QJSKZBXCFIPZ","description":"A generated security code for use with 2FA."},"otpauth_str":{"type":"string","description":"A one-time authentication URL to encode as the QR code.","format":"uri","example":"otpauth://totp/Example:root?secret=CAOXW75HKYJJ6E5Y&issuer=Example"}},"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","example":"twofactorauth_generate_tfa_config","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"54","parameters":[],"description":"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 `twofactorauth_set_tfa_config` function to configure Two-Factor Authentication (2FA) on an account.","operationId":"twofactorauth_generate_tfa_config","summary":"Create a one-time authentication secret and code","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_generate_tfa_config\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_generate_tfa_config?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Authentication","Two-Factor Authentication"]}}},"x-tagGroups":[{"tags":["Two-Factor Authentication"],"name":"Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"Two-Factor Authentication","description":"Authentication / Two-Factor Authentication"}]},"get_api_pages":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2","x-tagGroups":[{"tags":["API Statistics"],"name":"API Development Tools"}],"paths":{"/get_api_pages":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"count":{"type":"integer","minimum":"1","description":"The total number of times that the system called the function on the day in the `timestamp` return.","example":"200000"},"timestamp":{"description":"The date that the system called the function.\n\n**Note:**\n\n  The time portion of this value is arbitrary. Only the date is valid.","format":"unix_timestamp","example":"1548828000","type":"integer"},"entry":{"type":"string","description":"The path to the file where the function executes.","example":"/usr/local/cpanel/base/frontend/jupiter/plugin1/index.html.tt"}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"get_api_pages","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86","parameters":[{"required":"false","in":"query","name":"type","schema":{"default":"cpapi1","example":"cpapi1","enum":["cpapi1"],"type":"string"},"description":"The cPanel API type to query."}],"description":"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.\n\n**Important:**\n\n  The function *only* 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 [Guide to Replacing cPanel API 1 Functions with UAPI Equivalents](https://go.cpanel.net/replacecpapi1) documentation.","operationId":"get_api_pages","x-cpanel-api-version":"WHM API 1","summary":"Return deprecated cPanel API 1 functions ","tags":["Server Administration","API Statistics"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_api_pages\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_api_pages?api.version=1"}]}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"API Development Tools / API Statistics","name":"API Statistics"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}]},"applist":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM"}}}],"tags":[{"name":"Applications","description":"API Development Tools / Applications"}],"paths":{"/applist":{"get":{"summary":"Return WHM API 1 functions list","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  applist\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/applist?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Applications"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"app":{"type":"array","items":{"type":"string"},"description":"An array of available WHM API 1 functions.","example":["accountsummary","listaccts"]}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","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."},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"applist","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the api call.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[],"operationId":"applist","description":"This function lists available WHM API 1 functions."}}},"x-tagGroups":[{"tags":["Applications"],"name":"API Development Tools"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"backup_destination_list":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Destination","description":"Backups / Backup Destination"}],"paths":{"/backup_destination_list":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"backup_destination_list","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"properties":{"destination_list":{"type":"array","description":"An array of objects containing backup destination information.","items":{"$ref":"#/components/schemas/BackupDestinationResponseType"}}},"type":"object"}}}}}}},"description":"This function lists backup destinations.","operationId":"backup_destination_list","parameters":[],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_list?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"tags":["Backup Destination"],"name":"Backups"}],"openapi":"3.0.2","info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{"FTPBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"type":"object","properties":{"username":{"description":"The remote server account's username.","example":"username","type":"string"},"host":{"description":"The remote server's hostname.","format":"domain","example":"backups.example.com","type":"string"},"timeout":{"description":"The session timeout, in seconds.","default":"30","example":"300","minimum":"30","type":"integer","maximum":"300"},"port":{"default":"21","description":"The remote server's FTP port.","example":"21","type":"integer","maximum":"65535","minimum":"1"},"path":{"type":"string","example":"/backups","format":"path","description":"The path to the backups directory on the remote server."},"passive":{"example":"1","description":"Whether to use passive FTP.\n* `1` - Use passive FTP.\n* `0` - Use active FTP.","default":"1","type":"integer"}}}]},"LocalBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"properties":{"path":{"example":"/home/backups","description":"The absolute path to the backups directory.","format":"path","type":"string"},"no_mount_fail":{"type":"integer","default":"0","description":"Whether to fail the backup attempt if the mount fails.\n* `1` - Fail the backup attempt.\n* `0` - Do **not** fail the backup attempt.","example":"0","enum":["1","0"]},"mount":{"description":"Whether the path is mounted.\n* `1` - The path is mounted.\n* `0` - The path is **not** mounted.","default":"0","example":"0","enum":["1","0"],"type":"integer"}},"type":"object"}]},"SFTPBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"properties":{"authtype":{"description":"The authorization type.\n* `password`\n* `key`","enum":["password","key"],"example":"password"},"username":{"description":"The remote server account's username.","example":"username","type":"string"},"host":{"type":"string","description":"The remote server's hostname.","format":"domain","example":"backups.example.com"},"privatekey":{"type":"string","description":"If the `authtype` return's value is `key`, the absolute path to the private key file.","example":"/home/backups/key"},"timeout":{"minimum":"30","maximum":"300","type":"integer","example":"300","description":"The session timeout, in seconds.","default":"30"},"port":{"type":"integer","maximum":"65535","minimum":"1","default":"21","description":"The remote server's FTP port.","example":"21"},"path":{"type":"string","description":"The path to the backups directory on the remote server.","format":"path","example":"/backups"}},"type":"object"}]},"GoogleDriveBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"type":"object","properties":{"client_id":{"example":"aBcdeFgHIjK123","description":"The Google Drive client ID.","type":"string"},"folder":{"type":"string","default":"","description":"The path to the backups directory, relative to the root directory, on the remote server.","example":"subfolder"},"client_secret":{"example":"aBcde123FgHIjK456","description":"The Google Drive client secret.","type":"string"},"timeout":{"example":"300","description":"The session timeout, in seconds.","default":"30","minimum":"30","maximum":"300","type":"integer"}}}]},"BackupDestinationResponseType":{"anyOf":[{"$ref":"#/components/schemas/AmazonS3BackupDestinationResponse"},{"$ref":"#/components/schemas/BackblazeBackupDestinationResponse"},{"$ref":"#/components/schemas/CustomBackupDestinationResponse"},{"$ref":"#/components/schemas/FTPBackupDestinationResponse"},{"$ref":"#/components/schemas/GoogleDriveBackupDestinationResponse"},{"$ref":"#/components/schemas/LocalBackupDestinationResponse"},{"$ref":"#/components/schemas/RsyncBackupDestinationResponse"},{"$ref":"#/components/schemas/S3CompatibleBackupDestinationResponse"},{"$ref":"#/components/schemas/SFTPBackupDestinationResponse"},{"$ref":"#/components/schemas/WebDAVBackupDestinationResponse"}],"discriminator":{"propertyName":"type","mapping":{"Backblaze":"#/components/schemas/BackblazeBackupDestinationResponse","GoogleDrive":"#/components/schemas/GoogleDriveBackupDestinationResponse","Rsync":"#/components/schemas/RsyncBackupDestinationResponse","AmazonS3":"#/components/schemas/AmazonS3BackupDestinationResponse","WebDAV":"#/components/schemas/WebDAVBackupDestinationResponse","Custom":"#/components/schemas/CustomBackupDestinationResponse","Local":"#/components/schemas/LocalBackupDestinationResponse","S3Compatible":"#/components/schemas/S3CompatibleBackupDestinationResponse","SFTP":"#/components/schemas/SFTPBackupDestinationResponse","FTP":"#/components/schemas/FTPBackupDestinationResponse"}}},"S3CompatibleBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"type":"object","properties":{"host":{"example":"www.s3example.com","description":"The S3-compatible provider's server.","type":"string"},"bucket":{"example":"ChockFullOfNuts","description":"The S3-compatible bucket.","type":"string"},"timeout":{"minimum":"30","type":"integer","maximum":"300","default":"30","description":"The session timeout, in seconds.","example":"300"},"folder":{"type":"string","default":"","description":"The path to the backups directory, relative to the root directory, on the remote server.","example":"subfolder"},"aws_access_key_id":{"description":"The S3-compatible provider key ID.","example":"s123456789","type":"string"}}}]},"BackupDestinationResponse":{"type":"object","properties":{"disable_reason":{"description":"An error message that explains why the backup is disabled.\n\n**Note:**\n\nYou will only see this return when the transport is disabled.","example":"Could not list files in destination: example","type":"string"},"id":{"example":"0W1ei2rd3A4lI5sT6he7Be8st","description":"The ID of the backup destination to modify.","type":"string"},"type":{"description":"The type of backup destination.","example":"Local","enum":["Custom","FTP","Local","SFTP","WebDAV","AmazonS3","Rsync","GoogleDrive","S3Compatible","Backblaze"],"type":"string"},"disabled":{"type":"integer","description":"Shows whether the backup destination is disabled.\n* `1` — The destination is disabled.\n* `0` — The destination is enabled.","enum":["0","1"],"example":"0"},"name":{"type":"string","example":"destination_name","description":"A new name for the backup destination."}}},"RsyncBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"properties":{"privatekey":{"example":"/home/backups/key","description":"If the `authtype` return's value is `key`, the absolute path to the private key file.","type":"string"},"path":{"type":"string","example":"/backups","description":"The path to the backups directory on the remote server.","format":"path"},"timeout":{"maximum":"300","type":"integer","minimum":"30","example":"300","description":"The session timeout, in seconds.","default":"30"},"port":{"minimum":"1","type":"integer","maximum":"65535","description":"The remote server's FTP port.","default":"22","example":"22"},"host":{"example":"backups.example.com","format":"domain","description":"The remote server's hostname.","type":"string"},"username":{"type":"string","example":"username","description":"The remote server account's username."},"authtype":{"enum":["password","key"],"example":"password","description":"The authorization type.\n* `password`\n* `key`"}},"type":"object"}]},"WebDAVBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"properties":{"timeout":{"default":"30","description":"The session timeout, in seconds.","example":"300","type":"integer","maximum":"300","minimum":"30"},"port":{"maximum":"65535","type":"integer","minimum":"1","example":"21","default":"21","description":"The remote server's FTP port."},"path":{"type":"string","format":"path","description":"The path to the backups directory on the remote server.","example":"/backups"},"ssl":{"example":"1","enum":["1","0"],"description":"Whether to use SSL.\n* `1` - Use SSL.\n* `0` - Do **not** use SSL.","default":"1","type":"integer"},"username":{"type":"string","description":"The remote server account's username.","example":"username"},"host":{"description":"The remote server's hostname.","format":"domain","example":"backups.example.com","type":"string"}},"type":"object"}]},"BackblazeBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"properties":{"application_key_id":{"type":"string","description":"The application key ID that authenticates the Backblaze B2 account.","example":"12a345B678c9"},"path":{"type":"string","example":"backups","format":"path","description":"The path to the backups directory on the remote server."},"application_key":{"description":"The application key's name.","example":"A123b45CD678e9","type":"string"},"bucket_id":{"description":"The bucket's ID.","example":"a12b34cd5678e9f","type":"string"},"timeout":{"example":"300","description":"The session timeout, in seconds.","default":"30","minimum":"30","maximum":"300","type":"integer"},"bucket_name":{"description":"The bucket's name.","example":"ChockFullOfNuts","type":"string"}},"type":"object"}]},"CustomBackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"type":"object","properties":{"timeout":{"type":"integer","maximum":"300","minimum":"30","default":"30","description":"The session timeout, in seconds.","example":"300"},"script":{"description":"The absolute file path of the user-supplied transport solution script.","example":"/home/backups/beammeupscotty.pl","type":"string"},"path":{"type":"string","format":"path","description":"The path to the backups directory on the remote server.","example":"/backups"},"username":{"example":"username","description":"The remote server account's username.","type":"string"},"host":{"type":"string","example":"backups.example.com","description":"The remote server's hostname.","format":"domain"}}}]},"AmazonS3BackupDestinationResponse":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationResponse"},{"type":"object","properties":{"folder":{"description":"The path to the backups directory, relative to the root directory, on the remote server.","default":"","example":"subfolder","type":"string"},"timeout":{"maximum":"300","type":"integer","minimum":"30","example":"300","description":"The session timeout, in seconds.","default":"30"},"bucket":{"type":"string","example":"ChockFullOfNuts","description":"The Amazon S3™ bucket."},"aws_access_key_id":{"type":"string","description":"The Amazon S3 Access Key ID.","example":"s123456789"}}}]}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"cpsc_remove_base_package":{"tags":[{"name":"cPCloud","description":"cPCloud related WHM API 1 functions."}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["cPCloud"],"name":"cPCloud"}],"paths":{"/cpsc_remove_base_package":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cpsc_remove_base_package \\\n  service=database\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_remove_base_package?api.version=1&service=database"}],"tags":["cPCloud"],"summary":"Install a cPCloud Service package.","x-cpanel-api-version":"WHM API 1","operationId":"cpsc_remove_base_package","description":"This function removes the package associated with the specified cPanel Services Cluster service.","x-cpanel-internal-only":"true","parameters":[{"description":"The name of the service package to remove.","schema":{"type":"string","example":"database"},"in":"query","name":"service","required":"true"}],"x-cpanel-available-version":"11.114","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"logfile":{"description":"The file location of the log that contains the output of the package uninstall.","example":"/var/log/cpanel/services.log","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","description":"The method name called.","example":"cpsc_remove_base_package"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}}}}},"description":"HTTP Request was successful."}}}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.111.0.9999","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"editquota":{"tags":[{"name":"Bandwidth and Disk Quotas","description":"Accounts / Bandwidth and Disk Quotas"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Accounts","tags":["Bandwidth and Disk Quotas"]}],"paths":{"/editquota":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"editquota"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Set quota for user.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"editquota","description":"This function modifies a user's disk quota.","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"user"},"description":"The cPanel account username."},{"required":"true","name":"quota","in":"query","schema":{"oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"type":"string"}],"example":"500"},"description":"The account's new quota.\n* A positive integer that represents the maximum amount of disk space, in megabytes (MB).\n* 0 or unlimited grants the account unlimited disk space."}],"x-cpanel-api-version":"WHM API 1","summary":"Update cPanel account disk quota","tags":["Bandwidth and Disk Quotas"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  editquota \\\n  user='user' \\\n  quota='500'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/editquota?api.version=1&user=user&quota=500","label":"URL","lang":"HTTP"}]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"88","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"backup_generate_google_oauth_uri":{"x-tagGroups":[{"name":"Backups","tags":["Backup Destination"]}],"paths":{"/backup_generate_google_oauth_uri":{"get":{"parameters":[{"name":"client_id","in":"query","required":"true","description":"The Google Drive client ID.","schema":{"example":"aBcdeFgHIjK123","type":"string"}},{"description":"The Google Drive\n[client secret](https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/).","schema":{"example":"aBcde123FgHIjK456","type":"string"},"name":"client_secret","in":"query","required":"true"}],"description":"This function generates a\n[Google Drive™ OAuth redirect URI](https://developers.google.com/identity/protocols/OAuth2InstalledApp).","operationId":"backup_generate_google_oauth_uri","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"description":"The method name called.","example":"backup_generate_google_oauth_uri","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"type":"object","properties":{"uri":{"type":"string","format":"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"}}}},"type":"object"}}}}},"x-cpanel-available-version":"68","tags":["Backups","Backup Destination"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_generate_google_oauth_uri \\\n  client_id='aBcdeFgHIjK123' \\\n  client_secret='aBcde123FgHIjK456'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_generate_google_oauth_uri?api.version=1&client_id=aBcdeFgHIjK123&client_secret=aBcde123FgHIjK456","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Create Google Drive™ OAuth redirect URI"}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Destination","description":"Backups / Backup Destination"}],"servers":[{"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."}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"modsec_remove_vendor":{"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Vendor Settings","description":"Web Server Security (ModSecurity) / Rule Vendor Settings"}],"paths":{"/modsec_remove_vendor":{"get":{"parameters":[{"required":"true","name":"vendor_id","in":"query","schema":{"type":"string","example":"SomeVendor"},"description":"The ModSecurity vendor's unique short name."}],"operationId":"modsec_remove_vendor","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.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"modsec_remove_vendor"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_remove_vendor \\\n  vendor_id='SomeVendor'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_vendor?api.version=1&vendor_id=SomeVendor","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove ModSecurity vendor"}}},"x-tagGroups":[{"tags":["Rule Vendor Settings"],"name":"Web Server Security (ModSecurity)"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"hold_outgoing_email":{"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"paths":{"/hold_outgoing_email":{"get":{"tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  hold_outgoing_email \\\n  user='example'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/hold_outgoing_email?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","summary":"Add cPanel account to outbound email hold queue","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account.\n\n**Note**\n\nYou **cannot** suspend the root user's outgoing email with this function.","schema":{"example":"example","type":"string"}}],"operationId":"hold_outgoing_email","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"hold_outgoing_email","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"56"}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"limitbw":{"x-tagGroups":[{"tags":["Bandwidth and Disk Quotas"],"name":"Accounts"}],"paths":{"/limitbw":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"Bandwidth Limit for username has been set to unlimited megabytes","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"limitbw"}}},"data":{"properties":{"bwlimits":{"items":{"properties":{"domains":{"type":"array","items":{"type":"string"},"description":"An array of all of the cPanel account's domains.","example":["example.com","addondomain.com","subdomain.example.com"]},"human_bwused":{"example":"none","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.","pattern":"^(none|\\d+ MB)$","type":"string"},"bwlimit":{"description":"The account's new bandwidth quota, in megabytes (MB).\n* `0` - The user has unlimited bandwidth.","example":"0","type":"integer","minimum":"0"},"unlimited":{"enum":["0","1"],"example":"1","description":"Whether the account's bandwidth quota is unlimited.\n* `1` - Unlimited.\n* `0` - Not unlimited.","type":"integer"},"bwlimitenable":{"enum":["0","1"],"example":"0","description":"Whether bandwidth limiting is enabled for the account.\n* `1` - Enabled.\n* `0` - Disabled.","type":"integer"},"human_bwlimit":{"example":"500 MB","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.","type":"string","pattern":"^(unlimited|\\d+ MB)$"}},"type":"object"},"description":"An array of objects containing account information.","type":"array"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11","parameters":[{"description":"The username of a cPanel account on the server.","schema":{"example":"username","type":"string"},"in":"query","name":"user","required":"true"},{"schema":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"example":"0","default":"unlimited"},"description":"The account's new bandwidth quota, in megabytes (MB).\n* `0` and `unlimited` - Grant the user unlimited bandwidth","required":"false","in":"query","name":"bwlimit"}],"operationId":"limitbw","description":"This function modifies a cPanel account's bandwidth quota.","x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/limitbw?api.version=1&user=username","lang":"HTTP","label":"URL"}]}}},"tags":[{"name":"Bandwidth and Disk Quotas","description":"Accounts / Bandwidth and Disk Quotas"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2"},"has_services_cluster_configured":{"x-tagGroups":[{"tags":["ServicesCluster"],"name":"ServicesCluster"}],"paths":{"/has_services_cluster_configured":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Check whether a Services Cluster is configured.","tags":["ServicesCluster"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  has_services_cluster_configured\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/has_services_cluster_configured","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"11.110","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"has_cpsc":{"enum":["0","1"],"example":"1","description":"Whether a Services Cluster is configured on the server.\n\n* `1` - A Services Cluster is configured.\n* `0` - No Services Cluster is configured.","type":"integer"}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"has_services_cluster_configured","description":"The method name called."},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"has_services_cluster_configured","description":"This function returns whether a Services Cluster is configured on the server.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","parameters":[],"x-cpanel-internal-only":"true"}}},"tags":[{"description":"The ServicesCluster module for WHM API 1.","name":"ServicesCluster"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"verify_pushbullet_access":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Notifications","name":"Notifications"}],"paths":{"/verify_pushbullet_access":{"get":{"parameters":[],"description":"This function calls the WHM API 1 `send_test_pushbullet_note` function with the system's specified\nPushbullet™ accounts. You can specify Pushbullet accounts in the *Contact Information* section of WHM's\n*[Basic WebHost Manager Setup](https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/)*\ninterface (*Home >> Server Configuration >> Basic WebHost Manager Setup*).","operationId":"verify_pushbullet_access","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"verify_pushbullet_access"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"properties":{"results":{"items":{"type":"object","properties":{"result":{"properties":{"message_id":{"example":"554d2cbd-efe61da3cacb","description":"The test message's ID.","type":"string"},"payload":{"type":"object","description":"The payload from the Pushbullet server.\n\nFor more information, visit\n[Pushbullet's API documentation](https://go.cpanel.net/pushbulletdocs).","example":{"iden":"ABCDEFGHIJKLABCDEFGHIJKL","sender_email_normalized":"user@example.com","sender_name":"Firstname Lastname","sender_email":"user@example.com","modified":"1584457760.74993,","direction":"self","type":"note","sender_iden":"ABCDEFGHIJKL","title":"Test message (ID: J2SY)","dismissed":"false,","receiver_email_normalized":"user@example.com","body":"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.","receiver_iden":"ABCDEFGHIJKL","created":"1584457760.74319,","active":"true,","receiver_email":"user@example.com"}}},"type":"object"},"access_token":{"type":"string","example":"123456789012345678901234567890","description":"The Pushbullet token used.\n\n**Note:**\n* To access your Pushbullet token, navigate to\n[Pushbullet's My Account](https://go.cpanel.net/pushbulletaccount)\npage. It will appear under the Access Token heading.\n* This is confidential information that your server sends via a secure channel."}}},"type":"array"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  verify_pushbullet_access\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_pushbullet_access?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Server Administration","Notifications"],"summary":"Send Pushbullet™ access verification","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Notifications"]}],"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"ipv6_range_usage":{"paths":{"/ipv6_range_usage":{"get":{"operationId":"ipv6_range_usage","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.","parameters":[{"required":"true","name":"name","in":"query","schema":{"example":"TestRange","type":"string"},"description":"The IPv6 address range's name."}],"x-cpanel-available-version":"11.40","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"usage":{"properties":{"forbidden":{"type":"integer","minimum":"0","description":"The number of reserved IPv6 addresses.","example":"65536"},"used":{"description":"The number of assigned IPv6 addresses.","example":"20","type":"integer","minimum":"0"},"free":{"description":"The number of available IPv6 addresses.","example":"1000000","type":"integer","minimum":"0"}},"type":"object","description":"The IPv6 address range's information."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"command":{"description":"The method name called.","example":"ipv6_range_usage","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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","summary":"Return IPv6 address usage"}}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv6 Address Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"name":"IPv6 Address Settings","description":"IP Address Management / IPv6 Address Settings"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"get_provider_configuration_fields":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"External Authentication","description":"Authentication / External Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Authentication","tags":["External Authentication"]}],"paths":{"/get_provider_configuration_fields":{"get":{"operationId":"get_provider_configuration_fields","description":"This function retrieves the configuration fields for a external authentication identity provider.","parameters":[{"required":"true","name":"service_name","in":"query","schema":{"type":"string","example":"cpaneld","enum":["cpaneld","whostmgrd","webmaild"]},"description":"The cPanel & WHM service's name.\n\n* `cpaneld`\n* `whostmgrd`\n* `webmaild`"},{"in":"query","name":"provider_id","required":"true","description":"The identity provider's key.","schema":{"example":"cpanelid","type":"string"}}],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"configuration_fields":{"type":"array","items":{"properties":{"label":{"description":"The label of the configuration field.","type":"string"},"description":{"type":"string","description":"The description of the configuration field."},"field_id":{"description":"The name of the configuration field.","type":"string"},"display_order":{"minimum":"0","type":"integer","description":"The display order of the configuration field."},"value":{"type":"string","description":"The value of the configuration field, if available.","nullable":"true"}},"type":"object"},"description":"An array of objects containing the configuration information for each field.","example":[{"display_order":"1","field_id":"client_secret","value":null,"label":"Client Secret","description":"The Secret of the Client"},{"description":"The ID of the Client.","label":"Client ID","value":null,"field_id":"client_id","display_order":"0"}]}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"get_provider_configuration_fields","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_provider_configuration_fields \\\n  service_name='cpaneld' \\\n  provider_id='cpanelid'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_provider_configuration_fields?api.version=1&service_name=cpaneld&provider_id=cpanelid"}],"tags":["Authentication","External Authentication"],"summary":"Return identity provider configuration fields","x-cpanel-api-version":"WHM API 1"}}}},"toggle_user_backup_state":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Backups module for WHM API 1.","name":"Backups"},{"name":"Backup Settings","description":"Backups / Backup Settings"}],"paths":{"/toggle_user_backup_state":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  toggle_user_backup_state \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/toggle_user_backup_state?api.version=1&user=username"}],"tags":["Backups","Backup Settings"],"summary":"Enable or disable legacy backups","x-cpanel-api-version":"WHM API 1","description":"This function enables or disables legacy backups for a user.","operationId":"toggle_user_backup_state","parameters":[{"schema":{"example":"username","format":"username","type":"string"},"description":"The cPanel account's username.","required":"true","name":"user","in":"query"},{"in":"query","name":"legacy","required":"false","description":"Whether the account should use the legacy backup system.\n* `1` - Use the legacy backup system.\n* `0` - Use the standard backup system.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"}}],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"toggle_status":{"enum":["0","1"],"example":"0","description":"Whether backups are active on the account.\n* `1` - Active.\n* `0` - Inactive.","type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","example":"toggle_user_backup_state","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"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"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Backups","tags":["Backup Settings"]}],"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_api_calls":{"x-tagGroups":[{"name":"API Development Tools","tags":["API Statistics"]}],"paths":{"/get_api_calls":{"get":{"parameters":[{"schema":{"type":"string","default":"cpapi1","example":"cpapi1"},"description":"The cPanel API 1 function to query.\n\n**Note:**\n\n`cpapi1` is the **only** possible value.","required":"false","in":"query","name":"type"}],"operationId":"get_api_calls","description":"This function returns the cPanel API 1 functions that the system called on specific dates.\nThis is useful, for example, to check whether your system calls any cPanel API 1 functions.\n\n**Important:**\n\nThe function **only** returns cPanel API 1 functions. We deprecated cPanel API 1 and plan\nto remove those functions at a later date. For more information, read our\n[Guide to Replacing cPanel API 1 Functions with UAPI Equivalents](https://go.cpanel.net/replacecpapi1)\ndocumentation.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"get_api_calls"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"result":{"type":"array","items":{"properties":{"entry":{"description":"The cPanel API 1 module and function that the system executed.\n\nFor a complete list of cPanel API 1 functions, read our\n[Guide to cPanel API 1](https://go.cpanel.net/cpanelapi1)\ndocumentation.","example":"Email::printdomainoptions","type":"string"},"timestamp":{"type":"integer","description":"The date that the system called the function, in\n[Unix time format](https://wikipedia.org/wiki/Unix_time).","format":"unix_timestamp","example":"1548828000"},"count":{"type":"integer","example":"200000","description":"The total number of times that the system called\nthe function on the day in the `timestamp` return."}}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_api_calls\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_api_calls?api.version=1"}],"tags":["Server Administration","API Statistics"],"summary":"Return deprecated cPanel API 1 functions by date","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"API Statistics","description":"API Development Tools / API Statistics"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"list_pops_for":{"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"servers":[{"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."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"paths":{"/list_pops_for":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"list_pops_for","description":"The method name called."}}},"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"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.50","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account user for which to list all owned email accounts.","schema":{"type":"string","example":"example"}}],"operationId":"list_pops_for","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.","x-cpanel-api-version":"WHM API 1","summary":"Return cPanel account's email accounts","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_pops_for \\\n  user='example'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_pops_for?api.version=1&user=example","label":"URL","lang":"HTTP"}]}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"adddns":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Zones","name":"DNS Zones"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"DNS","tags":["DNS Zones"]}],"paths":{"/adddns":{"get":{"operationId":"adddns","description":"This function creates a DNS zone. If `trueowner=user`, this function does the following:\n* Adds a DNS entry in the `/var/cpanel/users/USER` file, where `USER` represents the `trueowner` parameter's value.\n* Creates the `/etc/vdomainaliases/DOMAIN` file, where `DOMAIN` represents the new zone's domain.\n* Creates the `/etc/vfilters/DOMAIN` file, where `DOMAIN` represents the new zone's domain.\n\nWhen 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.\n\nThis function generates the DNS zone's [MX record](https://en.wikipedia.org/wiki/MX_record), [domain PTR](https://en.wikipedia.org/wiki/Reverse_DNS_lookup#Multiple_pointer_records), and [A records](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A) automatically.\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 **cannot** use this function to add temporary domains.","parameters":[{"name":"domain","in":"query","required":"true","description":"The new zone's domain.","schema":{"format":"domain","example":"example.com","type":"string"}},{"description":"The domain's IP address.","schema":{"type":"string","example":"192.168.0.20","format":"ipv4"},"in":"query","name":"ip","required":"true"},{"description":"The zone file template.\n* `standard`\n* `simple`\n* `standardvirtualftp`\n* The name of a custom zone template file in the `/var/cpanel/zonetemplates` directory.","schema":{"example":"standard","default":"standard","type":"string"},"name":"template","in":"query","required":"false"},{"schema":{"type":"string","nullable":"true","format":"username","example":"user"},"description":"The new zone's owner. This parameter defaults to the currently-authenticated user.","required":"false","name":"trueowner","in":"query"},{"schema":{"nullable":"true","example":"2001:0db8:0:0:1:0:0:1","format":"ipv6","type":"string"},"description":"The domain's IPv6 address.","required":"false","in":"query","name":"ipv6"}],"x-cpanel-available-version":"11.28","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","description":"The method name called.","example":"adddns"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"Added example.com ok belonging to user user","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  adddns \\\n  domain='example.com' \\\n  trueowner='user' \\\n  ip='192.168.0.20'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/adddns?api.version=1&domain=example.com&ip=192.168.0.20"}],"tags":["DNS","DNS Zones"],"summary":"Create DNS zone","x-cpanel-api-version":"WHM API 1"}}}},"get_users_with_backup_metadata":{"paths":{"/get_users_with_backup_metadata":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_users_with_backup_metadata","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"accounts":{"description":"The cPanel user accounts on the server that contain backup metadata.","items":{"format":"username","example":"username","type":"string"},"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"70","parameters":[],"description":"This function lists users with backup metadata.","operationId":"get_users_with_backup_metadata","summary":"Return users with backup metadata","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_users_with_backup_metadata\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_with_backup_metadata?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Backups","Backup or Restore"]}}},"x-tagGroups":[{"name":"Backups","tags":["Backup or Restore"]}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Backups module for WHM API 1.","name":"Backups"},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"list_linked_server_nodes":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"name":"Server Administration","tags":["Server Nodes"]}],"paths":{"/list_linked_server_nodes":{"get":{"parameters":[],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"payload":{"type":"array","items":{"properties":{"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"},"hostname":{"format":"domain","description":"The remote server node's hostname.","example":"example.com","type":"string"},"last_check":{"type":"integer","example":"1556576165","description":"The last time that the server queried the current status of the remote server node.","format":"unix_timestamp"},"version":{"example":"11.90.0.0","format":"cPanel version","description":"The version of cPanel & WHM installed on the remote server node.","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"},"type":"object","example":{"Mail":{}},"description":"An object containing groups of services required for a remote server node to fulfill a specific role."},"enabled_services":{"type":"array","items":{"type":"string"},"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"]},"alias":{"example":"example","description":"The name of a linked remote server node.","type":"string"},"username":{"example":"root","format":"username","description":"The username required to make API calls to the linked remote server node.","type":"string"}},"type":"object"},"description":"An array of objects containing linked remote server nodes data."}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"list_linked_server_nodes","type":"string"}}}}}}}}},"x-cpanel-available-version":"86","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  list_linked_server_nodes\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_linked_server_nodes?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Server Administration","Server Nodes"],"summary":"Return all linked server nodes","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Server Nodes","description":"Server Administration / Server Nodes"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}]},"listlockedaccounts":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"name":"Accounts","tags":["Suspensions"]}],"paths":{"/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":[],"x-cpanel-available-version":"11.40","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"account":{"type":"array","items":{"type":"string"},"description":"A list of locked accounts on the server.","example":["account1","account2"]}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","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"},"result":{"enum":["0","1"],"example":"1","description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"listlockedaccounts"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["Suspensions"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  listlockedaccounts\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/listlockedaccounts?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return suspended cPanel accounts"}}},"tags":[{"description":"Accounts / Suspensions","name":"Suspensions"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"getdomainowner":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/getdomainowner":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return domain owner","tags":["Domain Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  getdomainowner \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/getdomainowner?api.version=1&domain=example.com"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"user":{"type":"string","format":"username","description":"The user who owns the domain.\n\n**Note:**\n\nThis value returns `null` if the user calling the function does not own the account for the domain **or** the domain does not exist on the server.","example":"username","nullable":"true"}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"getdomainowner"},"result":{"example":"1","enum":["0","1"],"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"78","parameters":[{"schema":{"type":"string","format":"domain","example":"example.com"},"description":"A domain on the system that is owned by the user calling this function.","required":"true","in":"query","name":"domain"}],"operationId":"getdomainowner","description":"This function lists the owner of a domain."}}},"x-tagGroups":[{"tags":["Domain Information"],"name":"Accounts"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Accounts / Domain Information","name":"Domain Information"}]},"remote_mysql_read_profiles":{"openapi":"3.0.2","info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"description":"Databases / Remote MySQL Databases","name":"Remote MySQL Databases"}],"paths":{"/remote_mysql_read_profiles":{"get":{"parameters":[],"operationId":"remote_mysql_read_profiles","description":"This function displays the details of all remote MySQL® profiles available in WHM.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"additionalProperties":{"type":"object","properties":{"mysql_port":{"example":"3306","description":"The MySQL server's port.","minimum":"1","maximum":"65535","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"},"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"},"mysql_version_is_supported":{"description":"Whether the system supports the server's MySQL version.\n\n* `1` — Supported.\n* `0` — **Not** supported.","example":"0","enum":["1","0"],"type":"integer"},"mysql_pass":{"type":"string","example":"123456luggage","description":"The MySQL server's password."},"setup_via":{"example":"Main terminal","description":"A description of the MySQL profile data.","maxLength":"255","type":"string"},"mysql_user":{"type":"string","format":"username","description":"The MySQL server's username.","example":"username"},"mysql_host":{"description":"The MySQL server's IP address or hostname.","oneOf":[{"type":"string","example":"hostname.example.com","description":"A valid hostname.","format":"hostname"},{"description":"A valid IP address.","example":"192.168.0.1","type":"string"}]}},"description":"An object containing the MySQL profile's data.\n\n**Note:**\n\nThe profile's name is the return's name."}},"example":{"MyProfile2":{"mysql_pass":"123456luggage","mysql_host":"192.168.0.2","mysql_user":"username","setup_via":"Main terminal","mysql_port":"3306","is_localhost_profile":"1","mysql_version_is_supported":"0","active":"0"},"MyProfile":{"mysql_pass":"123456luggage","setup_via":"Main terminal","mysql_user":"username","mysql_host":"192.168.0.1","is_localhost_profile":"1","mysql_port":"3306","active":"0","mysql_version_is_supported":"0"},"localhost":{"mysql_pass":"#1mpll-C","setup_via":"Auto-Migrated active profile","mysql_host":"localhost","mysql_user":"root","mysql_port":"3306","is_localhost_profile":"1","mysql_version_is_supported":"0","active":"1"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","example":"remote_mysql_read_profiles","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.52","x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Databases","Remote MySQL Databases"],"summary":"Return remote MySQL profiles","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Databases","tags":["Remote MySQL Databases"]}]},"get_homedir_roots":{"paths":{"/get_homedir_roots":{"get":{"x-cpanel-available-version":"88","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"get_homedir_roots"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"payload":{"description":"An array containing data for each home parent directory. This array contains the path return.","items":{"type":"object","properties":{"path":{"description":"directory where the system can store users' home directories. A valid directory path.","format":"local_path","example":"/home","type":"string"}}},"type":"array"}}}}}}}}},"description":"This function returns all the directories where the system stores\nusers' home directories. It returns them in descending order, based on the\ncurrent amount of available free disk space for each directory. For example,\nthe first directory the function lists has the most available free disk space.\n\n**Note:**\n\nUse 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.","operationId":"get_homedir_roots","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return home directories list","tags":["Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_homedir_roots\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_homedir_roots?api.version=1"}]}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Account Management","description":"Accounts / Account Management"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"install_rpm_plugin":{"paths":{"/install_rpm_plugin":{"get":{"tags":["RPM","Install or Uninstall Package"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  install_rpm_plugin \\\n  name='plugin name'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/install_rpm_plugin?api.version=1&name=plugin%20name","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Install WHM plugin RPM package","parameters":[{"in":"query","name":"name","required":"true","description":"The name of a plugin RPM to install.","schema":{"type":"string","example":"plugin name"}}],"description":"This function starts a plugin installation. The installation runs as a background process.","operationId":"install_rpm_plugin","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"install_rpm_plugin","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"pid":{"minimum":"0","type":"integer","example":"1234","description":"The PID of the process that will install the RPM."},"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"}},"type":"object"}}}}}}},"x-cpanel-available-version":"64"}}},"x-tagGroups":[{"name":"System Package Management","tags":["Install or Uninstall Package"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"Install or Uninstall Package","description":"System Package Management / Install or Uninstall Package"}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"edit_rpm_version":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/edit_rpm_version":{"get":{"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"status":{"enum":["0","1"],"example":"1","description":"Whether the function succeeded.\n\n* `1` — Success.\n* `0` — Failure.","type":"integer"}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"edit_rpm_version","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}}}},"operationId":"edit_rpm_version","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.","parameters":[{"required":"true","name":"section","in":"query","schema":{"example":"rpm_groups","type":"string"},"description":"The RPM's section."},{"in":"query","name":"key","required":"true","description":"The RPM's key.","schema":{"type":"string","example":"3rdparty"}},{"required":"true","in":"query","name":"value","schema":{"example":"cpanel-pcre","type":"string"},"description":"The RPM's value."}],"x-cpanel-api-version":"WHM API 1","summary":"Update rpm.versions system configuration","tags":["RPM","Package Manager Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  edit_rpm_version \\\n  section='rpm_groups' \\\n  key='3rdparty' \\\n  value='cpanel-pcre'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/edit_rpm_version?api.version=1&section=rpm_groups&key=3rdparty&value=cpanel-pcre"}]}}},"x-tagGroups":[{"tags":["Package Manager Settings"],"name":"System Package Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"Package Manager Settings","description":"System Package Management / Package Manager Settings"}]},"get_current_profile":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"openapi":"3.0.2","x-tagGroups":[{"name":"Server Administration","tags":["Server Profiles"]}],"paths":{"/get_current_profile":{"get":{"parameters":[],"operationId":"get_current_profile","description":"This function returns details about the server's current\n[cPanel & WHM server profile](https://docs.cpanel.net/whm/server-configuration/server-profile/).","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"name":{"type":"string","example":"Mail","description":"The name of the system's current server profile."},"code":{"description":"The code ID of the current profile.","example":"MAILNODE","type":"string"},"disabled_roles":{"type":"array","description":"The disabled roles of the current profile.","items":{"type":"object","properties":{"description":{"type":"string","description":"The role's description."},"module":{"description":"The role's module name.","type":"string"},"name":{"type":"string","description":"The role's name."}}},"example":[{"module":"FTP","description":"FTP allows users to manage the files associated with their site with an FTP client.","name":"FTP"},{"description":"File Storage allows users to access the File Manager and Git™ Version Control features.","module":"FileStorage","name":"File Storage"},{"name":"MySQL/MariaDB","description":"MySQL®/MariaDB allows users to create and manage MySQL/MariaDB databases.","module":"MySQL"},{"name":"PostgreSQL","description":"PostgreSQL allows users to create and manage PostgreSQL databases.","module":"Postgres"},{"name":"Web Disk","module":"WebDisk","description":"Web Disk allows users to manage and manipulate files on the server with multiple types of devices."},{"name":"Web Server","module":"WebServer","description":"Web Server allows users to create and manage websites for their domains."}]},"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"},"enabled_roles":{"type":"array","description":"The current profile's enabled roles.","items":{"properties":{"name":{"description":"The role's name.","type":"string"},"module":{"type":"string","description":"The role's module name."},"description":{"type":"string","description":"The role's description."}},"type":"object"},"example":[{"module":"CalendarContact","description":"Calendars and Contacts provides CalDAV and CardDAV services.","name":"Calendars and Contacts"},{"module":"MailReceive","description":"Receive Mail allows users to receive email, as well as create and manage their email accounts.","name":"Receive Mail"},{"description":"Send Mail allows users to send email.","module":"MailSend","name":"Send Mail"},{"name":"Local Mail","description":"Local Mail allows the system to process email.","module":"MailLocal"},{"description":"Webmail provides access to webmail services.","module":"Webmail","name":"Webmail"}]},"optional_roles":{"example":[{"name":"DNS","module":"DNS","description":"DNS allows users to create and edit Domain Name System zone files."},{"module":"SpamFilter","description":"Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.","name":"Spam Filter"}],"items":{"properties":{"description":{"description":"The role's description.","type":"string"},"module":{"type":"string","description":"The role's module name."},"name":{"description":"The role's name.","type":"string"}},"type":"object"},"description":"The optional roles of the current server profile.","type":"array"},"experimental":{"type":"integer","example":"1","enum":["1","0"],"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."}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_current_profile","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"76","tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_current_profile\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_current_profile?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return server's node profile"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Profiles","name":"Server Profiles"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"manage_features":{"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Server Administration / Updates","name":"Updates"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"paths":{"/manage_features":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update Feature Showcase","tags":["Packages","Updates"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  manage_features \\\n  action='info'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/manage_features?api.version=1&action=info","label":"URL","lang":"HTTP"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"action":{"type":"array","description":"An array of objects containing feature information.\n\n**Note:**\n\nThe function **only** returns this array if you pass the `enabled`\nor `disabled` values to the `action` parameter.","items":{"type":"object","properties":{"feature":{"description":"The feature's ID.","example":"mysql8","type":"string"},"status":{"type":"string","description":"The feature's state.","example":"Successfully performed 'enable' for mysql8"}}}},"feature":{"type":"array","items":{"type":"object","properties":{"vendor":{"example":"WebPros International, LLC","description":"The feature's vendor.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nvalue to the `action` parameter.","type":"string"},"feature_key":{"description":"The feature's ID.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nor `list` values to the `action` parameter.","example":"mysql8","type":"string"},"link":{"description":"The feature's documentation link.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nvalue to the `action` parameter.","format":"url","example":"https://go.cpanel.net/whmdocsUpgradeDBVersion","type":"string"},"enabled":{"description":"Whether the feature is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nor `list` values to the `action` parameter.","enum":["1","0"],"example":"0","type":"integer"},"description":{"type":"string","description":"The feature's description.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nvalue to the `action` parameter.","example":"MySQL® 8 is now available in cPanel and WHM for all supported operated operating systems. For more information, read our documentation (https://go.cpanel.net/whmdocsUpgradeDBVersion)."},"recommended":{"example":"0","enum":["1","0"],"description":"Whether we recommend that you install the feature.\n\n* `1` — Recommended.\n* `0` — **Not** recommended.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nvalue to the `action` parameter.","type":"integer"},"name":{"description":"The feature's name.\n\n**Note:**\n\nThe function **only** returns this value if you pass the `info`\nvalue to the `action` parameter.","example":"MySQL® 8 Now Available For Upgrade","type":"string"}}},"description":"An array of objects containing feature information.\n\n**Note:**\n\nThe function **only** returns this array if you pass the `info`\nor `list` values to the `action` parameter."}},"example":{"feature":[{"feature_key":"featured_example1","vendor":"Third Party, Inc.","link":"https://go.cpanel.net/featureshowcasefeatured_example1","recommended":"1","description":"This feature does things.","enabled":"1","name":"Featured Example 1"},{"link":"https://go.cpanel.net/featureshowcasefeatured_example2","vendor":"WebPros International, LLC","feature_key":"featured_example2","name":"Featured Example 2","enabled":"1","description":"This feature also does things.","recommended":"1"}]}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"manage_features"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.32","parameters":[{"description":"The function's action.\n\n* `info` — List full details for all available features.\n* `list` — List the feature IDs for all available features.\n* `enable` — Enable the feature or features called in the `features` parameter.\n* `disable` — Disable the feature or features called in the `features` parameter.","schema":{"type":"string","enum":["info","list","enable","disable"],"example":"info"},"name":"action","in":"query","required":"true"},{"description":"The feature's ID.\n\n**Note:**\n\nYou **must** use this parameter if you pass the `enable` or `disable` value for\nthe `action` parameter.","schema":{"type":"string","example":"features_example1"},"in":"query","name":"features","required":"false"}],"description":"This function lists and manages items in the\n[Feature Showcase](https://go.cpanel.net/GuidetotheFeatureShowcase).\n\n**Note:**\n\n* This function's output changes, depending on which value you pass to the `action` parameter.\n* The example in this document displays the function's return when the `action`\nparameter value is `info`.","operationId":"manage_features"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"get_autossl_logs_catalog":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"paths":{"/get_autossl_logs_catalog":{"get":{"x-cpanel-available-version":"58","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"get_autossl_logs_catalog","description":"The method name called."},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"type":"object","properties":{"payload":{"type":"array","items":{"type":"object","properties":{"in_progress":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether AutoSSL is in progress.\n* `1` — AutoSSL is in progress.\n* `0` — AutoSSL is **not** in progress."},"start_time":{"description":"When the system created the log file.","format":"ISO-8601 Date Time","example":"2016-06-09T14:25:37.000Z","type":"string"},"provider":{"type":"string","example":"cPanel","description":"The AutoSSL provider's name."},"username":{"description":"The user that corresponds to the AutoSSL log entry.\n* The username of a cPanel user that the account owns.\n* `*` — All users.","example":"username","type":"string"}}},"description":"An array of objects that contain information about an AutoSSL log file."}}}}}}}}},"description":"This function lists the AutoSSL feature's log files.","operationId":"get_autossl_logs_catalog","parameters":[],"summary":"Return AutoSSL log files","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_autossl_logs_catalog\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_logs_catalog?api.version=1"}],"tags":["SSL","Auto-Generated Certificates"]}}}},"get_users_and_domains_with_backup_metadata":{"x-tagGroups":[{"tags":["Backup or Restore"],"name":"Backups"}],"paths":{"/get_users_and_domains_with_backup_metadata":{"get":{"tags":["Backups","Backup or Restore"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_users_and_domains_with_backup_metadata\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_and_domains_with_backup_metadata?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return users and domains with backup metadata","parameters":[],"operationId":"get_users_and_domains_with_backup_metadata","description":"This function lists all users and their domains that have backup metadata.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"type":"string","format":"domain","description":"The cPanel user account's associated domain.","example":"example.com"},"type":"object","example":{"username2":"example.net","username":"example.com","username3":"example.org"},"description":"Keys are cPanel user accounts that contain backup metadata."},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"get_users_and_domains_with_backup_metadata"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"74"}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"delete_customizations":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.99.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"description":"The Customizations module for WHM API 1.","name":"Customizations"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Customizations","tags":["Brand","Customizations"]}],"paths":{"/delete_customizations":{"get":{"summary":"Delete customization data","x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"true","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_customizations \\\n  application='cpanel' \\\n  theme='jupiter'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_customizations?api.version=1&application=cpanel&theme=jupiter"}],"tags":["Customizations"],"x-cpanel-available-version":"100","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"delete_customizations","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"operationId":"delete_customizations","description":"This function deletes customization data.\n\nCustomization data includes brand logos and colors.\n\nServer owners and resellers can supply customization data to whitelabel portions\nof the product or customize the cPanel experience for their users.\n\nThis function is used to delete customization data for the Jupiter theme **only**.\n\nIf you provide the optional `path` parameter, the API will removed only the specific element specified in the `.` separated path.\nSee the parameter for more details.","parameters":[{"in":"query","name":"application","required":"true","description":"The application name for the customization.","schema":{"type":"string","enum":["cpanel","webmail"],"example":"cpanel"}},{"schema":{"example":"jupiter","type":"string"},"description":"The theme name for the customization.","required":"true","in":"query","name":"theme"},{"schema":{"type":"string","example":"brand.icon.description"},"description":"The JSONPath expression to reach to property you want to delete. We support only the\nsubset of JSONPath using the `.` style notation. There is presently no other JSONPath\nfeatures supported.","required":"false","in":"query","name":"path"}]}}}},"update_integration_link_token":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Integrations","tags":["Links"]}],"paths":{"/update_integration_link_token":{"get":{"parameters":[{"schema":{"type":"string","example":"username"},"description":"The cPanel account name.","required":"true","in":"query","name":"user"},{"required":"true","in":"query","name":"app","schema":{"type":"string","example":"WHMCS_billing"},"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."},{"required":"true","name":"token","in":"query","schema":{"example":"subway","type":"string"},"description":"The new access token to use for the application."}],"description":"This function refreshes the token for an integration link.","operationId":"update_integration_link_token","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"update_integration_link_token","description":"The method name called.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Ok"}}},"data":{}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"54","tags":["Integration","Links"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_integration_link_token \\\n  user='username' \\\n  app='WHMCS_billing' \\\n  token='subway'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","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","summary":"Update integration link token"}}},"tags":[{"description":"The Integration module for WHM API 1.","name":"Integration"},{"description":"Integrations / Links","name":"Links"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"background_mysql_upgrade_checker_run":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"name":"Databases","tags":["Manage MySQL Server"]}],"paths":{"/background_mysql_upgrade_checker_run":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"log_entry":{"type":"string","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"},"pid":{"minimum":"1","type":"integer","example":"23456","description":"The upgrade check's process ID."}}},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"background_mysql_upgrade_checker_run","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"88","parameters":[],"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","summary":"Validate MySQL status before upgrade","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  background_mysql_upgrade_checker_run\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/background_mysql_upgrade_checker_run?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Databases","Manage MySQL Server"]}}},"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"Manage MySQL Server","description":"Databases / Manage MySQL Server"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"set_application_contact_event_importance":{"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Notifications","name":"Notifications"}],"paths":{"/set_application_contact_event_importance":{"get":{"parameters":[{"required":"true","in":"query","name":"app","schema":{"type":"string","example":"Check"},"description":"The cPanel & WHM application module's name."},{"description":"The event's name.","schema":{"example":"SecurityAdvisorStateChange","type":"string"},"in":"query","name":"event","required":"true"},{"required":"true","in":"query","name":"importance","schema":{"type":"string","enum":["High","Medium","Low","Disabled"],"example":"Disabled"},"description":"The importance level at which to send the notification.\n\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`"}],"operationId":"set_application_contact_event_importance","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.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"example":"set_application_contact_event_importance","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"58","tags":["Server Administration","Notifications"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_application_contact_event_importance \\\n  app='Check' \\\n  event='SecurityAdvisorStateChange' \\\n  importance='Disabled'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange&importance=Disabled","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Update app's event contact importance setting"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Notifications"]}],"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"restore_queue_list_completed":{"paths":{"/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":[],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"examples":{"restore_queue_add_task_function":{"value":{"metadata":{"command":"restore_queue_list_completed","version":"1","result":"1","reason":"OK"},"data":{"restore_job":[{"status_info":{"started":"1586188078","finished":"1586188203","result":"2","log":"warning","transfer_session_id":"userbackup20200406154758JqBa","skipped_items":null,"status":"2","dangerous_items":null,"statusmsg":"warning","altered_items":null,"warnings":null,"restore_logfile":"item-RESTORE_AccountLocal_mrfrog"},"restore_job":{"user":"mrfrog","options":{"mail_config":"0","destid":"local","give_ip":"0","mysql":"0","subdomains":"0"},"restore_point":"2020-03-29"}}]}},"description":"A task that the restore_queue_add_task function added."},"restorepkg":{"description":"A task that the /scripts/restorepkg script added.","value":{"data":{"restore_job":[{"status_info":{"result":"1","started":"1355840811","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"},"restore_job":{"user":"example","options":{"give_ip":"0","mail_config":"1","subdomains":"1","mysql":"1"},"restore_point":"YYYY-MM-DD"}},{"status_info":{"log":"","result":"0","started":"1355840823","finished":"1355840823"},"restore_job":{"options":{"mail_config":"0","give_ip":"1","subdomains":"0","mysql":"1"},"restore_point":"YYYY-MM-DD","user":"bcow"}}]},"metadata":{"version":"1","command":"restore_queue_list_completed","result":"1","reason":"OK"}}}},"schema":{"type":"object","properties":{"data":{"properties":{"restore_job":{"description":"An array of objects that contain information about a completed task in the restoration queue.","items":{"properties":{"status_info":{"properties":{"altered_items":{"type":"integer","nullable":"true","description":"The number of items that the restoration process changed.","example":"1"},"dangerous_items":{"type":"integer","description":"The number of items in the restoration process that may cause problems on the account.","example":"1","nullable":"true"},"skipped_items":{"type":"integer","nullable":"true","description":"The number of items that the restoration process skipped.","example":"1"},"restore_logfile":{"type":"string","example":"item-RESTORE_AccountLocal_example","description":"The restoration log file's name."},"warnings":{"items":{"type":"string"},"description":"Any warnings about the restoration process.","example":null,"nullable":"true","type":"array"},"result":{"type":"integer","enum":["0","1","2"],"example":"1","description":"Whether the task completed successfully.\n* `1` - Success.\n* `0` - Failure.\n* `2` - Warning."},"started":{"type":"string","example":"1355840811","description":"The restoration process's start time for this task.","format":"unix_timestamp"},"finished":{"format":"unix_timestamp","description":"The time that the restoration process completed this task.","example":"1355840823","type":"string"},"transfer_session_id":{"example":"userbackup20200406154758JqBa","description":"The restoration transfer session's ID.","type":"string"},"log":{"type":"string","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.","description":"The task's log information."}},"type":"object","description":"An object that contains information about the task's status."},"restore_job":{"type":"object","properties":{"options":{"description":"An object that contains information about the task's options.","type":"object","properties":{"subdomains":{"type":"integer","description":"Whether the function restored the account's subdomains.\n* `1` - Restored.\n* `0` - Did **not** restore.","example":"1","enum":["0","1"]},"mysql":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the task restored the account's MySQL® databases.\n* `1` - Restored.\n* `0` - Did **not** restore."},"give_ip":{"example":"1","enum":["0","1"],"description":"Whether the task assigned the account a dedicated IP address.\n* `1` - Assigned.\n* `0` - Did **not** assign.","type":"integer"},"destid":{"description":"The destination's identification string.\n* `local` — The local directory.\n* The destination ID string's value.","example":"LmTZCUpqqLSPH8AO7pVtIeNK","type":"string"},"mail_config":{"type":"integer","description":"Whether the function restored the account's email configuration.\n* `1` - Restored.\n* `0` - Did **not** restore.","example":"1","enum":["0","1"]}}},"restore_point":{"type":"string","example":"2015-10-21T00:00:00.000Z","description":"The date of the backup that the task used.","format":"ISO-8601 Date"},"user":{"example":"username","description":"The cPanel account's username.","format":"username","type":"string"}},"description":"An object that contains the task's settings."}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"restore_queue_list_completed","description":"The method name called.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"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"}],"tags":["Account Restoration","Restore Queue Reporting"],"summary":"Return completed restoration tasks list","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Restore Queue Reporting"],"name":"Account Restoration"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"description":"Account Restoration / Restore Queue Reporting","name":"Restore Queue Reporting"}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"remote_mysql_update_profile":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"Remote MySQL Databases","description":"Databases / Remote MySQL Databases"}],"paths":{"/remote_mysql_update_profile":{"get":{"operationId":"remote_mysql_update_profile","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.","parameters":[{"description":"The profile's name.","schema":{"type":"string","example":"MyProfile"},"name":"name","in":"query","required":"true"},{"required":"false","name":"mysql_host","in":"query","schema":{"example":"192.168.0.1","oneOf":[{"format":"ipv4","type":"string"},{"type":"string","format":"hostname"}]},"description":"The MySQL server's IP address or hostname."},{"name":"mysql_user","in":"query","required":"false","description":"The MySQL server's username.","schema":{"type":"string","example":"username"}},{"schema":{"example":"12345luggage","type":"string"},"description":"The MySQL server's password.","required":"false","in":"query","name":"mysql_pass"},{"in":"query","name":"mysql_port","required":"false","description":"The MySQL server's port.","schema":{"example":"3306","type":"integer","maximum":"65535","minimum":"1"}},{"schema":{"type":"string","maxLength":"255","example":"Main terminal"},"description":"A description of the profile data.","required":"false","name":"setup_via","in":"query"}],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"profile_saved":{"example":"MyProfile","description":"The updated profile's name.","type":"string"},"profile_details":{"description":"An object containing the updated profile's data.","type":"object","properties":{"mysql_pass":{"description":"The MySQL server's password.","example":"12345luggage","type":"string"},"mysql_port":{"description":"The MySQL server's port.","example":"3306","type":"integer","maximum":"65535","minimum":"1"},"mysql_user":{"example":"username","description":"The MySQL server's username.","type":"string"},"mysql_host":{"oneOf":[{"type":"string","format":"ipv4"},{"format":"hostname","type":"string"}],"example":"192.168.0.1","description":"The MySQL server's IP address or hostname."},"setup_via":{"maxLength":"255","type":"string","description":"A description of the profile data.","example":"Main terminal"},"active":{"enum":["0","1"],"example":"0","description":"Whether the system uses this profile to access the MySQL server.\n* `1` — Active.\n* `0` — Not active.","type":"integer"}}}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"remote_mysql_update_profile","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"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"}],"tags":["Databases","Remote MySQL Databases"],"summary":"Update remote MySQL profile","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Databases","tags":["Remote MySQL Databases"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"modsec_add_vendor":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"}],"paths":{"/modsec_add_vendor":{"get":{"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","summary":"Add ModSecurity vendor rules","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.","schema":{"type":"string","example":"https://example.com/update/meta_MyVendor.yaml","format":"url"},"name":"url","in":"query","required":"true"},{"schema":{"type":"integer","enum":["1","0"],"example":"1","default":"1"},"description":"Whether to enable the vendor.\n\n* `1` — Enabled.\n* `0` — Disabled.","required":"false","name":"enabled","in":"query"}],"x-cpanel-available-version":"11.46","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"modsec_add_vendor","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"type":"object","properties":{"archive_url":{"type":"string","example":"http://example.com/update/MyVendor.zip","format":"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."},"vendor_id":{"example":"MyVendor","description":"The vendor's unique short name.","type":"string"},"name":{"description":"The vendor's name.","example":"My Vendor","type":"string"},"path":{"type":"string","example":"/usr/local/apache/conf/modsec_vendor_configs/MyVendor","format":"path","description":"The absolute path to the directory that contains the vendor's configuration files."},"installed_from":{"type":"string","format":"url","description":"The vendor's metadata file URL.","example":"https://example.com/update/meta_MyVendor.yaml"},"vendor_url":{"example":"http://www.example.com","description":"The vendor's website URL.","format":"url","type":"string"},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/MD5) checksum value.","format":"md5","example":"307cb5320441ebd712e5581d12100dc9","type":"string"},"enabled":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether the function enabled the vendor.\n\n* `1` — Enabled.\n* `0` — **Not** enabled."},"inst_dist":{"type":"string","example":"MyVendor-2","description":"The rule set's unique identifier."},"cpanel_provided":{"type":"integer","description":"Whether WebPros International, LLC provided the vendor.\n\n* `1` — cPanel-provided.\n* `0` — **Not** cPanel-provided.","enum":["1","0"],"example":"0"},"dist_sha512":{"type":"string","example":"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb","format":"sha512","description":"The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash."},"installed":{"type":"integer","description":"Whether the function installed the vendor.\n\n* `1` — Installed.\n* `0` — **Not** installed.","example":"1","enum":["1","0"]},"report_url":{"type":"string","example":"https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229","format":"url","description":"The URL to which the system will send reports."},"supported_versions":{"example":["2.7.5","2.7.7","2.8.0","2.9.0","2.9.1","2.9.2","2.9.3"],"description":"A list of the ModSecurity versions that the vendor supports.","items":{"type":"string"},"type":"array"},"description":{"description":"The vendor's description.","example":"This is an example of a custom vendor set (updated)","type":"string"}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"import_zone_key":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"DNS Security","description":"DNS / DNS Security"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"DNS","tags":["DNS Security"]}],"paths":{"/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":[{"schema":{"example":"example.com","type":"string"},"description":"The domain for which to import the security key.","required":"true","in":"query","name":"domain"},{"schema":{"type":"string","example":"ksk"},"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.","required":"true","in":"query","name":"key_type"},{"required":"true","name":"key_data","in":"query","schema":{"type":"string","example":"Private-key-format:%20v1.2%0AAlgorithm:%2013%20\\(ECDSAP256SHA256\\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A"},"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."}],"x-cpanel-available-version":"86","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","description":"The method name called.","example":"import_zone_key"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"properties":{"import_key_id":{"description":"The system's assigned ID for the imported security key.","example":"1","minimum":"1","type":"integer"}},"type":"object"}},"type":"object"}}}}},"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["DNS","DNS Security"],"summary":"Import DNSSEC key","x-cpanel-api-version":"WHM API 1"}}}},"package_manager_get_build_log":{"paths":{"/package_manager_get_build_log":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_get_build_log \\\n  build='1234' \\\n  offset='4567'\n","lang":"Shell","label":"CLI"},{"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"}],"tags":["RPM","Package Manager Settings"],"summary":"Return RPM management build log","x-cpanel-api-version":"WHM API 1","operationId":"package_manager_get_build_log","description":"This function returns build log content.","parameters":[{"in":"query","name":"build","required":"true","description":"The build process ID returned by the `package_manager_submit_actions` function.","schema":{"minimum":"1","type":"integer","example":"1234"}},{"description":"The position in the build log from which you wish to display entries.","schema":{"type":"integer","minimum":"0","example":"4567","format":"bytes"},"name":"offset","in":"query","required":"true"}],"x-cpanel-available-version":"11.52","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"offset":{"example":"9672","format":"bytes","description":"The last position that the system read in the build log.","minimum":"0","type":"integer"},"still_running":{"example":"1","enum":["1","0"],"description":"Whether the build process is in progress.\n\n* `1` — In progress.\n* `0` — Complete.","type":"integer"},"content":{"example":["line1","line2","line3"],"items":{"type":"string"},"description":"The most recent build log entries.","type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"description":"The method name called.","example":"package_manager_get_build_log","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}}}}},"x-tagGroups":[{"name":"System Package Management","tags":["Package Manager Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"Package Manager Settings","description":"System Package Management / Package Manager Settings"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"convertopensshtoputty":{"paths":{"/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":[{"schema":{"type":"string","example":"KeyFile"},"description":"The private key file's name.","required":"true","in":"query","name":"file"},{"name":"passphrase","in":"query","required":"false","description":"The private key file's passphrase.","schema":{"example":"12345luggage","default":"","type":"string"}},{"in":"query","name":"keep_file","required":"false","description":"Whether to keep the OpenSSH file on the server after conversion.\n* `1` — Keep the file.\n* `0` — Delete the file.","schema":{"type":"integer","default":"1","example":"0","enum":["0","1"]}}],"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"convertopensshtoputty","type":"string"}}},"data":{"type":"object","properties":{"key":{"type":"string","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":"object"}}}}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  convertopensshtoputty \\\n  file='KeyFile'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/convertopensshtoputty?api.version=1&file=KeyFile"}],"tags":["SSH Keys and Connections"],"summary":"Migrate OpenSSH key to PuTTY format","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["SSH Keys and Connections"],"name":"Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"Authentication / SSH Keys and Connections","name":"SSH Keys and Connections"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"restore_config_from_upload":{"x-tagGroups":[{"name":"Server Administration","tags":["Configuration Clusters"]}],"paths":{"/restore_config_from_upload":{"post":{"x-codeSamples":[{"source":"whmapi1 --input=json --output=jsonpretty \\\n  restore_config_from_upload\n","lang":"Shell","label":"CLI"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/restore_config_from_upload HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"tags":["Server Administration","Configuration Clusters"],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The configuration file data, in `multipart/form-data` format.\n\n**Note:**\n\nWhen you call this function on the command line, you **must** provide the configuration file's filepath. For example, you would use the 'file=@/var/cpanel/cpanel.config' parameter structure to call this function.","format":"binary","example":"#### NOTICE ####\n# After manually editing any configuration settings in this file,\n# please run '/usr/local/cpanel/scripts/restartsrv_cpsrvd' or\n# 'service cpanel restart' to fully update your server's configuration.\nRS=jupiter\nVFILTERDIR=/etc/vfilters\naccess_log=/usr/local/cpanel/logs/access_log\naccount_login_access=owner_root\nadminuser=cpanel\nallow_deprecated_accesshash=0\nallow_login_autocomplete=1\nallow_server_info_status_from=\nallow_weak_checksums=0\nallowcpsslinstall=1\nallowparkhostnamedomainsubdomains=0\nallowparkonothers=0\nallowremotedomains=0\nallowresellershostnamedomainsubdomains=0\nallowunregistereddomains=1\nallowwhmparkonothers=0\nalwaysredirecttossl=1\napache_port=0.0.0.0:80\napache_ssl_port=0.0.0.0:443\napi_shell=1\nautocreateaentries=1\nautodiscover_host=cpanelemaildiscovery.cpanel.net\nautodiscover_mail_service=imap\nautodiscover_proxy_subdomains=0\nautoupdate_certificate_on_hostname_mismatch=1\nawstatsbrowserupdate=0\nawstatsreversedns=0\nbasename=cpanel\nbind_deferred_restart_time=2\nblockcommondomains=1\nbwcycle=2\ncgihidepass=1\ncheck_zone_owner=1\ncheck_zone_syntax=1\nchkservd_check_interval=300\nchkservd_hang_allowed_intervals=2\nchkservd_plaintext_notify=0\ncluster_autodisable_threshold=10\ncluster_failure_notifications=1\nconserve_memory=0\ncookieipvalidation=strict\ncoredump=0\ncpaddons_adminemail=\ncpaddons_autoupdate=1\ncpaddons_max_moderation_req_all_mod=99\ncpaddons_max_moderation_req_per_mod=99\ncpaddons_moderation_request=0\ncpaddons_no_3rd_party=0\ncpaddons_no_modified_cpanel=1\ncpaddons_notify_owner=1\ncpaddons_notify_root=1\ncpaddons_notify_users=Allow users to choose\ncpanel_locale=\ncpredirect=Origin Domain Name\ncpredirectssl=SSL Certificate Name\ncpsrvd-domainlookup=0\ncreate_account_dkim=1\ncreate_account_spf=1\ncycle_hours=24\ndatabase_prefix=1\ndebughooks=0\ndefault_archive-logs=1\ndefault_login_theme=cpanel\ndefault_pkg_bwlimit=1048576\ndefault_pkg_max_emailacct_quota=1024\ndefault_pkg_quota=10240\ndefault_remove-old-archived-logs=1\ndefaultmailaction=localuser\ndisable-php-as-reseller-security=0\ndisablequotacache=0\ndisk_usage_include_mailman=1\ndisk_usage_include_sqldbs=1\ndisplay_cpanel_doclinks=0\ndnsadmin_log=0\ndnsadmin_verbose_sync=0\ndnsadminapp\ndnslookuponconnect=0\ndocroot=/usr/local/cpanel/base\ndomainowner_mail_pass=0\ndormant_services=cpdavd,cphulkd,cpsrvd,dnsadmin,spamd\ndumplogs=1\nemail_account_quota_default_selected=userdefined\nemail_account_quota_userdefined_default_value=1024\nemail_outbound_spam_detect_action=noaction\nemail_outbound_spam_detect_enable=1\nemail_outbound_spam_detect_threshold=500\nemail_send_limits_count_mailman=0\nemail_send_limits_defer_cutoff=125\nemail_send_limits_max_defer_fail_percentage\nemail_send_limits_min_defer_fail_to_trigger_protection=5\nemailarchive=0\nemailpasswords=0\nemailsperdaynotify\nemailusers_diskusage_critical_contact_admin=1\nemailusers_diskusage_critical_percent=90.0000\nemailusers_diskusage_full_contact_admin=1\nemailusers_diskusage_full_percent=98.0000\nemailusers_diskusage_warn_contact_admin=0\nemailusers_diskusage_warn_percent=80.0000\nemailusers_mailbox_critical_percent=90.0000\nemailusers_mailbox_full_percent=98.0000\nemailusers_mailbox_warn_percent=80.0000\nemailusersbandwidthexceed=0\nemailusersbandwidthexceed70=0\nemailusersbandwidthexceed75=0\nemailusersbandwidthexceed80=1\nemailusersbandwidthexceed85=0\nemailusersbandwidthexceed90=0\nemailusersbandwidthexceed95=0\nemailusersbandwidthexceed97=0\nemailusersbandwidthexceed98=0\nemailusersbandwidthexceed99=0\nempty_trash_days=disabled\nenable_piped_logs=1\nenablecompileroptimizations=0\nenablefileprotect=1\nengine=cpanel\nenginepl=cpanel.pl\nengineroot=/usr/local/cpanel\nexim-retrytime=15\nexim_retention_days=10\neximmailtrap=1\nextracpus=0\nfile_upload_max_bytes\nfile_upload_must_leave_bytes=5\nfile_usage=0\nftpquotacheck_expire_time=30\nftpserver=pure-ftpd\ngzip_compression_level=6\ngzip_pigz_block_size=4096\ngzip_pigz_processes=1\nhtaccess_check_recurse=2\nhttpd_deferred_restart_time=0\ninvite_sub=1\nionice_bandwidth_processing=6\nionice_cpbackup=6\nionice_dovecot_maintenance=7\nionice_email_archive_maintenance=7\nionice_ftpquotacheck=6\nionice_log_processing=7\nionice_quotacheck=6\nionice_userbackup=7\nionice_userproc=6\nipv6_control=0\nipv6_listen=0\njailapache=0\njaildefaultshell=0\njailmountbinsuid=0\njailmountusrbinsuid=0\njailprocmode=mount_proc_jailed_fallback_full\nkeepftplogs=0\nkeeplogs=0\nkeepstatslog=0\nloadthreshold\nlocal_nameserver_type=bind\nlog_successful_logins=0\nlogchmod=0640\nlogout_redirect_url=\nmailbox_storage_format=maildir\nmailserver=dovecot\nmaintenance_rpm_version_check=1\nmaintenance_rpm_version_digest_check=1\nmaxcpsrvdconnections=200\nmaxemailsperhour\nmaxmem=768\nmin_time_between_apache_graceful_restarts=10\nminpwstrength=0\nmodsec_keep_hits=7\nmycnf_auto_adjust_innodb_buffer_pool_size=0\nmycnf_auto_adjust_maxallowedpacket=1\nmycnf_auto_adjust_openfiles_limit=1\nmyname=cpaneld\nmysql-host=localhost\nmysql-version=5.5\nmysqldebug=0\nnobodyspam=1\nnocpbackuplogs=0\nnosendlangupdates=0\nnotify_expiring_certificates=1\nnumacctlist=30\noverwritecustomproxysubdomains=0\noverwritecustomsrvrecords=0\npermit_appconfig_entries_without_acls=0\npermit_appconfig_entries_without_features=0\npermit_unregistered_apps_as_reseller=0\npermit_unregistered_apps_as_root=0\nphp_max_execution_time=90\nphp_memory_limit=128\nphp_post_max_size=55\nphp_system_default_version=ea-php56\nphp_upload_max_filesize=50\nphploader=\nphpopenbasedirhome=0\npma_disableis=0\npopbeforesmtp=0\npopbeforesmtpsenders=0\npostgresdebug=0\nproduct=cPanel\nproxysubdomains=1\nproxysubdomainsfornewaccounts=1\nproxysubdomainsoverride=1\npublichtmlsubsonly=1\nquery_apache_for_nobody_senders=1\nreferrerblanksafety=0\nreferrersafety=0\nremotewhmtimeout=35\nrepquota_timeout=60\nrequiressl=0\nresetpass=1\nresetpass_sub=1\nroot=/usr/local/cpanel\nrotatelogs_size_threshhold_in_megabytes=300\nroundcube_db=sqlite\nrpmup_allow_kernel=0\nselfsigned_generation_for_bestavailable_ssl_install=1\nsend_error_reports=1\nsend_server_configuration=1\nsend_server_usage=1\nserver_locale=en\nshow_reboot_banner=1\nshowwhmbwusageinmegs=0\nsignature_validation=Release and Development Keyrings\nskip_chkservd_recovery_notify=0\nskipanalog=0\nskipapacheclientsoptimizer=0\nskipawstats=0\nskipboxcheck=1\nskipboxtrapper=0\nskipbwlimitcheck=0\nskipchkservd=0\nskipcpbandwd=0\nskipdiskcheck=0\nskipdiskusage=0\nskipeximstats=0\nskiphttpauth=1\nskipjailmanager=0\nskipmailauthoptimizer=0\nskipmailman=0\nskipmodseclog=0\nskipnotifyacctbackupfailure=0\nskipoomcheck=0\nskipparentcheck=1\nskiprecentauthedmailiptracker=0\nskiproundcube=0\nskipspamassassin=0\nskipspambox=1\nskipsqmail=0\nskiptailwatchd=0\nskipwebalizer=0\nsmtpmailgidonly=1\nssh_host_key_checking=0\nstats_log=/usr/local/cpanel/logs/stats_log\nstatsloglevel=1\nstatthreshhold=256\nsystem_diskusage_critical_percent=92.5500\nsystem_diskusage_warn_percent=82.5500\ntcp_check_failure_threshold=3\ntransfers_timeout=1800\ntweak_unset_vars=\nupcp_log_retention_days=45\nupdate_log_analysis_retention_length=90\nuse_apache_md5_for_htaccess=1\nuse_information_schema=1\nuseauthnameservers=1\nusemailformailmanurl=0\nusemysqloldpass=0\nuserdirprotect=1\nverify_3rdparty_cpaddons=0\nversion=3.4\nxframecpsrvd=0\nenable_api_log=0","type":"string"},"module":{"description":"The configuration module's name.\n\n* `Basic` — The [Basic WebHost Manager Setup](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup) configuration.\n* `Main` — The [Tweak Settings](https://go.cpanel.net/whmdocsTweakSettings) configuration.\n\n**Important:**\n\nThis parameter is case-sensitive. You **must** enter the parameter in the correct case format; otherwise, the function will fail.","enum":["Basic","Main"],"example":"Main","type":"string"}},"required":["module","file"],"type":"object"}}}},"summary":"Update configuration file from backup via POST","x-cpanel-api-version":"WHM API 1","operationId":"restore_config_from_upload","description":"This function restores a configuration backup file via HTTP POST\nmethod. If the backup file does **not** contain any changes, the system does **not** write to the configuration file.\n\n**Note:**\n\nThe format for this command line example differs from our standard format because the function **only** accepts an HTTP POST request. For more information about how to call this request method, read [Mozilla's POST documentation](https://go.cpanel.net/Mozilla-POST-documentation).","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","example":"restore_config_from_upload","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}}}}}}},"x-cpanel-available-version":"74"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Configuration Clusters","description":"Server Administration / Configuration Clusters"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"deactivate_zone_key":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"tags":["DNS Security"],"name":"DNS"}],"paths":{"/deactivate_zone_key":{"get":{"parameters":[{"required":"true","in":"query","name":"domain","schema":{"example":"example.com","type":"string"},"description":"The domain for which to deactivate a security key."},{"schema":{"example":"1","type":"integer"},"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.","required":"true","in":"query","name":"key_id"}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"deactivate_zone_key","description":"The method name called."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"86","tags":["DNS","DNS Security"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  deactivate_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","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","summary":"Disable domain's DNSSEC key"}}},"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"description":"DNS / DNS Security","name":"DNS Security"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}]},"background_mysql_upgrade_status":{"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/background_mysql_upgrade_status":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"state":{"type":"string","example":"success","enum":["success","failed","in progress"],"description":"The upgrade's state.\n* success\n* failed\n* in progress"},"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"},"error":{"type":"integer","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":"object"},"metadata":{"properties":{"command":{"type":"string","example":"background_mysql_upgrade_status","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"cPanel 11.48","parameters":[{"description":"The logfile's name.\n\n**Note:**\n\n  Log files exist in the `/var/cpanel/logs/` directory.","schema":{"type":"string","example":"mysql_upgrade.20141108-172923"},"in":"query","name":"upgrade_id","required":"true"}],"operationId":"background_mysql_upgrade_status","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.","summary":"Return MySQL or MariaDB upgrade status","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  background_mysql_upgrade_status \\\n  upgrade_id='mysql_upgrade.20141108-172923'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/background_mysql_upgrade_status?api.version=1&upgrade_id=mysql_upgrade.20141108-172923"}],"tags":["Databases","Manage MySQL Server"]}}},"x-tagGroups":[{"name":"Databases","tags":["Manage MySQL Server"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"description":"Databases / Manage MySQL Server","name":"Manage MySQL Server"}]},"get_linked_server_node":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Server Nodes","name":"Server Nodes"}],"paths":{"/get_linked_server_node":{"get":{"parameters":[{"name":"alias","in":"query","required":"true","description":"The name of a linked remote server node.","schema":{"example":"example","type":"string"}}],"description":"This function returns details about a linked remote server node.","operationId":"get_linked_server_node","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"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.","example":"1","enum":["0","1"],"type":"integer"},"hostname":{"type":"string","format":"domain","description":"The remote server node's hostname.","example":"example.com"},"last_check":{"format":"unix_timestamp","description":"The last time that the server queried the current status of the remote server node.","example":"1556576165","type":"integer"},"username":{"format":"username","description":"The username required to make API calls to the linked remote server node.","example":"root","type":"string"},"system_settings":{"example":{"Mail":{"globalspamassassin":"0"}},"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.","additionalProperties":{"type":"object"}},"worker_capabilities":{"additionalProperties":{"type":"object"},"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":{}}},"enabled_services":{"type":"array","items":{"example":"apache_php_fpm","type":"string"},"description":"The services enabled on the linked remote server node."},"version":{"type":"string","example":"11.86.0.0","description":"The version of cPanel & WHM installed on the remote server node."}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"description":"The method name called.","example":"get_linked_server_node","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."}}}},"type":"object"}}}}},"x-cpanel-available-version":"86","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_linked_server_node \\\n  alias='example'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_linked_server_node?api.version=1&alias=example"}],"tags":["Server Administration","Server Nodes"],"summary":"Return linked remote server node settings","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Server Nodes"],"name":"Server Administration"}],"openapi":"3.0.2","info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"update_customizations":{"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.99.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The Customizations module for WHM API 1.","name":"Customizations"}],"paths":{"/update_customizations":{"post":{"x-cpanel-available-version":"100","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"update_customizations","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"operationId":"update_customizations","description":"This function supplies branding data for a specific application and theme.\n\nCustomization data includes brand logos and colors.\n\nThis function is used to save customization data for the Jupiter theme **only**.","parameters":[{"schema":{"type":"string","example":"cpanel","enum":["cpanel","webmail"]},"description":"The application name for the customization.","required":"true","name":"application","in":"query"},{"in":"query","name":"theme","required":"true","description":"The theme name for the customization.","schema":{"example":"jupiter","enum":["jupiter"],"type":"string"}},{"in":"query","name":"data","required":"true","description":"The theme data to save.","content":{"application/json":{"schema":{"example":{"documentation":{"url":"https://hosting.com/documentation"},"brand":{"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=","colors":{"primary":"#961218","accent":"#00FF00"},"logo":{"description":"The orange logo for cPanel.","forDarkBackground":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA5NCAyMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTQgMjA7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRkZGRkZGO30KPC9zdHlsZT4KPHRpdGxlPmNQYW5lbCBMb2dvIC0gV2hpdGU8L3RpdGxlPgo8ZyBpZD0iTGF5ZXJfMiI+Cgk8ZyBpZD0iTGF5ZXJfMS0yIj4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNy44LDQuOWg1LjlsLTAuOSwzLjNjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEg3LjljLTAuNiwwLTEuMiwwLjItMS43LDAuNQoJCQljLTAuNSwwLjQtMC44LDAuOS0xLDEuNGMtMC4xLDAuNC0wLjEsMC45LDAsMS4zYzAuMSwwLjQsMC4zLDAuNywwLjUsMS4xYzAuMiwwLjMsMC42LDAuNiwwLjksMC43QzcsMTUsNy41LDE1LjEsNy45LDE1LjFoMS43CgkJCWMwLjMsMCwwLjYsMC4xLDAuOCwwLjRjMC4yLDAuMiwwLjMsMC41LDAuMiwwLjhsLTEsMy43SDcuNmMtMS4yLDAtMi40LTAuMy0zLjQtMC44Yy0xLTAuNS0xLjktMS4yLTIuNi0yLjEKCQkJYy0xLjQtMS44LTEuOS00LjItMS4zLTYuNGwwLjEtMC40YzAuNC0xLjYsMS40LTIuOSwyLjctMy45QzMuOCw2LDQuNSw1LjYsNS4zLDUuM0M2LjEsNS4xLDYuOSw0LjksNy44LDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMTAuNywyMGw1LjEtMTguNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMUMxNywwLjEsMTcuNSwwLDE4LDBoNS40YzEuMiwwLDIuNCwwLjMsMy40LDAuOGMyLjEsMSwzLjUsMi45LDQsNQoJCQljMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjRsLTAuMSwwLjRjLTAuMiwwLjgtMC42LDEuNS0xLDIuMmMtMS40LDItMy44LDMuMy02LjMsMy4zaC00LjdsMC45LTMuNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMQoJCQljMC40LTAuMywwLjgtMC40LDEuMy0wLjRoMS41YzEuMiwwLDIuMy0wLjgsMi43LTJjMC4xLTAuNCwwLjEtMC44LDAtMS4yYy0wLjEtMC40LTAuMy0wLjctMC41LTEuMWMtMC4yLTAuMy0wLjYtMC42LTAuOS0wLjcKCQkJQzI0LDUsMjMuNiw0LjksMjMuMSw0LjloLTIuOWwtMy44LDEzLjZjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEgxMC43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00My4xLDEwLjJsMC4xLTAuM2MwLTAuMSwwLTAuMi0wLjEtMC4zYy0wLjEtMC4xLTAuMi0wLjEtMC4zLTAuMWgtOC40Yy0wLjMsMC0wLjctMC4xLTEtMC4yCgkJCWMtMC4zLTAuMS0wLjUtMC4zLTAuNy0wLjZjLTAuMi0wLjItMC4zLTAuNS0wLjQtMC44Yy0wLjEtMC4zLTAuMS0wLjcsMC0xbDAuNS0xLjloMTEuNGMwLjcsMCwxLjMsMC4xLDEuOSwwLjQKCQkJYzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yYzAuNCwwLjUsMC43LDEuMSwwLjgsMS43YzAuMSwwLjYsMC4xLDEuMywwLDEuOWwtMi4xLDcuM0M0NiwxOSw0NC42LDIwLDQzLDIwbC04LjQsMAoJCQljLTEuNCwwLTIuNy0wLjYtMy42LTEuN2MtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMi0wLjctMC4xLTEuNCwwLjEtMmwwLjEtMC40YzAuMS0wLjUsMC4zLTAuOSwwLjYtMS4zYzAuMy0wLjQsMC42LTAuNywxLTEKCQkJYzAuNC0wLjMsMC44LTAuNSwxLjMtMC43YzAuNS0wLjIsMS0wLjIsMS41LTAuMmg3LjFsLTAuNSwxLjljLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNGgtMy4yCgkJCWMtMC4zLDAtMC41LDAuMS0wLjYsMC40Yy0wLjEsMC4yLDAsMC40LDAuMSwwLjVjMC4xLDAuMSwwLjMsMC4yLDAuNSwwLjJoNS4xYzAuMiwwLDAuNCwwLDAuNS0wLjFjMC4xLTAuMSwwLjItMC4yLDAuMy0wLjQKCQkJbDAuMS0wLjJMNDMuMSwxMC4yeiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik01OC4zLDQuOWMxLjIsMCwyLjQsMC4zLDMuNSwwLjhjMSwwLjUsMS45LDEuMiwyLjYsMi4xYzAuNywwLjksMS4yLDEuOSwxLjQsM2MwLjMsMS4xLDAuMiwyLjMtMC4xLDMuNAoJCQlsLTEuMyw0LjdjLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNINjBjLTAuNSwwLTEtMC40LTEtMC45YzAtMC4xLDAtMC4yLDAtMC4zbDEuNi01LjcKCQkJYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43Yy0wLjQtMC4yLTAuOC0wLjMtMS4yLTAuM2gtMi45bC0yLjUsOS4xCgkJCWMtMC4xLDAuMy0wLjMsMC42LTAuNiwwLjhjLTAuMywwLjItMC42LDAuMy0xLDAuM2gtMi44Yy0wLjMsMC0wLjYtMC4xLTAuOC0wLjRjLTAuMi0wLjItMC4zLTAuNS0wLjItMC44bDMuOC0xMy45TDU4LjMsNC45eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik03My42LDkuN2MtMC4yLDAuMi0wLjQsMC40LTAuNCwwLjZMNzIsMTQuNWMtMC4xLDAuNCwwLjEsMC44LDAuNSwwLjljMC4xLDAsMC4xLDAsMC4yLDBoMTAuOGwtMC44LDMKCQkJYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMUM4MS41LDE5LjksODEsMjAsODAuNiwyMGgtOS44Yy0wLjcsMC0xLjMtMC4xLTEuOS0wLjRjLTAuNi0wLjMtMS4xLTAuNy0xLjUtMS4yCgkJCWMtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMS0wLjYtMC4xLTEuMywwLjEtMS45bDEuNi01LjdjMC4yLTAuNiwwLjQtMS4yLDAuOC0xLjdjMC43LTEsMS43LTEuOCwyLjktMi4yCgkJCWMwLjYtMC4yLDEuMy0wLjMsMS45LTAuM2g2LjljMC43LDAsMS4zLDAuMSwxLjksMC40YzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yQzg0LjYsNyw4NC45LDcuNiw4NSw4LjJjMC4xLDAuNiwwLjEsMS4zLTAuMSwxLjkKCQkJbC0wLjUsMS43Yy0wLjIsMC43LTAuNiwxLjQtMS4zLDEuOGMtMC42LDAuNS0xLjQsMC43LTIuMSwwLjdoLTcuOGwwLjUtMS44YzAuMS0wLjQsMC40LTAuOCwwLjgtMS4xYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40SDc5CgkJCWMwLjMsMCwwLjUtMC4xLDAuNi0wLjRsMC4xLTAuNGMwLjEtMC4zLTAuMS0wLjYtMC40LTAuN2MwLDAtMC4xLDAtMC4xLDBoLTQuOEM3NCw5LjQsNzMuOCw5LjUsNzMuNiw5Ljd6Ii8+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTgzLjUsMjBsNS4yLTE4LjljMC4xLTAuMywwLjMtMC42LDAuNi0wLjhjMC4zLTAuMiwwLjYtMC4zLDEtMC4zSDkzYzAuMywwLDAuNiwwLjEsMC44LDAuNAoJCQlDOTQsMC42LDk0LjEsMC45LDk0LDEuMmwtMy45LDEzLjljLTAuMiwwLjctMC41LDEuNC0wLjksMmMtMC40LDAuNi0wLjksMS4xLTEuNSwxLjVjLTAuNiwwLjQtMS4yLDAuOC0xLjksMQoJCQlDODUsMTkuOSw4NC4yLDIwLDgzLjUsMjB6Ii8+Cgk8L2c+CjwvZz4KPC9zdmc+","forLightBackground":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9InhMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgOTQgMjAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDk0IDIwOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+CjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI+Cgkuc3Qwe2ZpbGw6I0ZGNkMyQzt9Cjwvc3R5bGU+Cjx0aXRsZT5jUGFuZWwgTG9nbyAtIE9yYW5nZTwvdGl0bGU+CjxnIGlkPSJ4TGF5ZXJfMiI+Cgk8ZyBpZD0ieExheWVyXzEtMiI+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTcuOCw0LjloNS45bC0wLjksMy4zYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRINy45Yy0wLjYsMC0xLjIsMC4yLTEuNywwLjUKCQkJYy0wLjUsMC40LTAuOCwwLjktMSwxLjRjLTAuMSwwLjQtMC4xLDAuOSwwLDEuM2MwLjEsMC40LDAuMywwLjcsMC41LDEuMWMwLjIsMC4zLDAuNiwwLjYsMC45LDAuN0M3LDE1LDcuNSwxNS4xLDcuOSwxNS4xaDEuNwoJCQljMC4zLDAsMC42LDAuMSwwLjgsMC40YzAuMiwwLjIsMC4zLDAuNSwwLjIsMC44bC0xLDMuN0g3LjZjLTEuMiwwLTIuNC0wLjMtMy40LTAuOGMtMS0wLjUtMS45LTEuMi0yLjYtMi4xCgkJCWMtMS40LTEuOC0xLjktNC4yLTEuMy02LjRsMC4xLTAuNGMwLjQtMS42LDEuNC0yLjksMi43LTMuOUMzLjgsNiw0LjUsNS42LDUuMyw1LjNDNi4xLDUuMSw2LjksNC45LDcuOCw0Ljl6Ii8+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwLjcsMjBsNS4xLTE4LjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjFDMTcsMC4xLDE3LjUsMCwxOCwwaDUuNGMxLjIsMCwyLjQsMC4zLDMuNCwwLjhjMi4xLDEsMy41LDIuOSw0LDUKCQkJYzAuMywxLjEsMC4yLDIuMy0wLjEsMy40bC0wLjEsMC40Yy0wLjIsMC44LTAuNiwxLjUtMSwyLjJjLTEuNCwyLTMuOCwzLjMtNi4zLDMuM2gtNC43bDAuOS0zLjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjEKCQkJYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40aDEuNWMxLjIsMCwyLjMtMC44LDIuNy0yYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43CgkJCUMyNCw1LDIzLjYsNC45LDIzLjEsNC45aC0yLjlsLTMuOCwxMy42Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRIMTAuN3oiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDMuMSwxMC4ybDAuMS0wLjNjMC0wLjEsMC0wLjItMC4xLTAuM2MtMC4xLTAuMS0wLjItMC4xLTAuMy0wLjFoLTguNGMtMC4zLDAtMC43LTAuMS0xLTAuMgoJCQljLTAuMy0wLjEtMC41LTAuMy0wLjctMC42Yy0wLjItMC4yLTAuMy0wLjUtMC40LTAuOGMtMC4xLTAuMy0wLjEtMC43LDAtMWwwLjUtMS45aDExLjRjMC43LDAsMS4zLDAuMSwxLjksMC40CgkJCWMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMmMwLjQsMC41LDAuNywxLjEsMC44LDEuN2MwLjEsMC42LDAuMSwxLjMsMCwxLjlsLTIuMSw3LjNDNDYsMTksNDQuNiwyMCw0MywyMGwtOC40LDAKCQkJYy0xLjQsMC0yLjctMC42LTMuNi0xLjdjLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjItMC43LTAuMS0xLjQsMC4xLTJsMC4xLTAuNGMwLjEtMC41LDAuMy0wLjksMC42LTEuM2MwLjMtMC40LDAuNi0wLjcsMS0xCgkJCWMwLjQtMC4zLDAuOC0wLjUsMS4zLTAuN2MwLjUtMC4yLDEtMC4yLDEuNS0wLjJoNy4xbC0wLjUsMS45Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRoLTMuMgoJCQljLTAuMywwLTAuNSwwLjEtMC42LDAuNGMtMC4xLDAuMiwwLDAuNCwwLjEsMC41YzAuMSwwLjEsMC4zLDAuMiwwLjUsMC4yaDUuMWMwLjIsMCwwLjQsMCwwLjUtMC4xYzAuMS0wLjEsMC4yLTAuMiwwLjMtMC40CgkJCWwwLjEtMC4yTDQzLjEsMTAuMnoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTguMyw0LjljMS4yLDAsMi40LDAuMywzLjUsMC44YzEsMC41LDEuOSwxLjIsMi42LDIuMWMwLjcsMC45LDEuMiwxLjksMS40LDNjMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjQKCQkJbC0xLjMsNC43Yy0wLjEsMC4zLTAuMywwLjYtMC42LDAuOGMtMC4zLDAuMi0wLjYsMC4zLTEsMC4zSDYwYy0wLjUsMC0xLTAuNC0xLTAuOWMwLTAuMSwwLTAuMiwwLTAuM2wxLjYtNS43CgkJCWMwLjEtMC40LDAuMS0wLjgsMC0xLjJjLTAuMS0wLjQtMC4zLTAuNy0wLjUtMS4xYy0wLjItMC4zLTAuNi0wLjYtMC45LTAuN2MtMC40LTAuMi0wLjgtMC4zLTEuMi0wLjNoLTIuOWwtMi41LDkuMQoJCQljLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNoLTIuOGMtMC4zLDAtMC42LTAuMS0wLjgtMC40Yy0wLjItMC4yLTAuMy0wLjUtMC4yLTAuOGwzLjgtMTMuOUw1OC4zLDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNzMuNiw5LjdjLTAuMiwwLjItMC40LDAuNC0wLjQsMC42TDcyLDE0LjVjLTAuMSwwLjQsMC4xLDAuOCwwLjUsMC45YzAuMSwwLDAuMSwwLDAuMiwwaDEwLjhsLTAuOCwzCgkJCWMtMC4xLDAuNC0wLjQsMC44LTAuOCwxLjFDODEuNSwxOS45LDgxLDIwLDgwLjYsMjBoLTkuOGMtMC43LDAtMS4zLTAuMS0xLjktMC40Yy0wLjYtMC4zLTEuMS0wLjctMS41LTEuMgoJCQljLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjEtMC42LTAuMS0xLjMsMC4xLTEuOWwxLjYtNS43YzAuMi0wLjYsMC40LTEuMiwwLjgtMS43YzAuNy0xLDEuNy0xLjgsMi45LTIuMgoJCQljMC42LTAuMiwxLjMtMC4zLDEuOS0wLjNoNi45YzAuNywwLDEuMywwLjEsMS45LDAuNGMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMkM4NC42LDcsODQuOSw3LjYsODUsOC4yYzAuMSwwLjYsMC4xLDEuMy0wLjEsMS45CgkJCWwtMC41LDEuN2MtMC4yLDAuNy0wLjYsMS40LTEuMywxLjhjLTAuNiwwLjUtMS40LDAuNy0yLjEsMC43aC03LjhsMC41LTEuOGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMWMwLjQtMC4zLDAuOC0wLjQsMS4zLTAuNEg3OQoJCQljMC4zLDAsMC41LTAuMSwwLjYtMC40bDAuMS0wLjRjMC4xLTAuMy0wLjEtMC42LTAuNC0wLjdjMCwwLTAuMSwwLTAuMSwwaC00LjhDNzQsOS40LDczLjgsOS41LDczLjYsOS43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik04My41LDIwbDUuMi0xOC45YzAuMS0wLjMsMC4zLTAuNiwwLjYtMC44YzAuMy0wLjIsMC42LTAuMywxLTAuM0g5M2MwLjMsMCwwLjYsMC4xLDAuOCwwLjQKCQkJQzk0LDAuNiw5NC4xLDAuOSw5NCwxLjJsLTMuOSwxMy45Yy0wLjIsMC43LTAuNSwxLjQtMC45LDJjLTAuNCwwLjYtMC45LDEuMS0xLjUsMS41Yy0wLjYsMC40LTEuMiwwLjgtMS45LDEKCQkJQzg1LDE5LjksODQuMiwyMCw4My41LDIweiIvPgoJPC9nPgo8L2c+Cjwvc3ZnPgo="}},"help":{"url":"https://hosting.com/get-help"}},"properties":{"documentation":{"description":"Optional documentation information.","properties":{"url":{"type":"string","format":"url","description":"URL to the companies documentation site. This url will replace the default documentation link in the footer if defined.","example":"https://hosting.com/documentation"}},"type":"object"},"brand":{"description":"The customization data.","properties":{"favicon":{"example":"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=","description":"The base64-encoded favorites icon. This function **only** accepts the ICO file format.","format":"base64","type":"string"},"colors":{"description":"The hex-code colors used to apply a custom color palette to the interface.","type":"object","properties":{"primary":{"description":"The primary color to apply to the interface.","example":"#961218","type":"string"},"accent":{"type":"string","example":"#00FF00","description":"The hex-code to set in the customization."}}},"logo":{"type":"object","properties":{"forDarkBackground":{"example":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA5NCAyMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTQgMjA7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRkZGRkZGO30KPC9zdHlsZT4KPHRpdGxlPmNQYW5lbCBMb2dvIC0gV2hpdGU8L3RpdGxlPgo8ZyBpZD0iTGF5ZXJfMiI+Cgk8ZyBpZD0iTGF5ZXJfMS0yIj4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNy44LDQuOWg1LjlsLTAuOSwzLjNjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEg3LjljLTAuNiwwLTEuMiwwLjItMS43LDAuNQoJCQljLTAuNSwwLjQtMC44LDAuOS0xLDEuNGMtMC4xLDAuNC0wLjEsMC45LDAsMS4zYzAuMSwwLjQsMC4zLDAuNywwLjUsMS4xYzAuMiwwLjMsMC42LDAuNiwwLjksMC43QzcsMTUsNy41LDE1LjEsNy45LDE1LjFoMS43CgkJCWMwLjMsMCwwLjYsMC4xLDAuOCwwLjRjMC4yLDAuMiwwLjMsMC41LDAuMiwwLjhsLTEsMy43SDcuNmMtMS4yLDAtMi40LTAuMy0zLjQtMC44Yy0xLTAuNS0xLjktMS4yLTIuNi0yLjEKCQkJYy0xLjQtMS44LTEuOS00LjItMS4zLTYuNGwwLjEtMC40YzAuNC0xLjYsMS40LTIuOSwyLjctMy45QzMuOCw2LDQuNSw1LjYsNS4zLDUuM0M2LjEsNS4xLDYuOSw0LjksNy44LDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMTAuNywyMGw1LjEtMTguNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMUMxNywwLjEsMTcuNSwwLDE4LDBoNS40YzEuMiwwLDIuNCwwLjMsMy40LDAuOGMyLjEsMSwzLjUsMi45LDQsNQoJCQljMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjRsLTAuMSwwLjRjLTAuMiwwLjgtMC42LDEuNS0xLDIuMmMtMS40LDItMy44LDMuMy02LjMsMy4zaC00LjdsMC45LTMuNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMQoJCQljMC40LTAuMywwLjgtMC40LDEuMy0wLjRoMS41YzEuMiwwLDIuMy0wLjgsMi43LTJjMC4xLTAuNCwwLjEtMC44LDAtMS4yYy0wLjEtMC40LTAuMy0wLjctMC41LTEuMWMtMC4yLTAuMy0wLjYtMC42LTAuOS0wLjcKCQkJQzI0LDUsMjMuNiw0LjksMjMuMSw0LjloLTIuOWwtMy44LDEzLjZjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEgxMC43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00My4xLDEwLjJsMC4xLTAuM2MwLTAuMSwwLTAuMi0wLjEtMC4zYy0wLjEtMC4xLTAuMi0wLjEtMC4zLTAuMWgtOC40Yy0wLjMsMC0wLjctMC4xLTEtMC4yCgkJCWMtMC4zLTAuMS0wLjUtMC4zLTAuNy0wLjZjLTAuMi0wLjItMC4zLTAuNS0wLjQtMC44Yy0wLjEtMC4zLTAuMS0wLjcsMC0xbDAuNS0xLjloMTEuNGMwLjcsMCwxLjMsMC4xLDEuOSwwLjQKCQkJYzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yYzAuNCwwLjUsMC43LDEuMSwwLjgsMS43YzAuMSwwLjYsMC4xLDEuMywwLDEuOWwtMi4xLDcuM0M0NiwxOSw0NC42LDIwLDQzLDIwbC04LjQsMAoJCQljLTEuNCwwLTIuNy0wLjYtMy42LTEuN2MtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMi0wLjctMC4xLTEuNCwwLjEtMmwwLjEtMC40YzAuMS0wLjUsMC4zLTAuOSwwLjYtMS4zYzAuMy0wLjQsMC42LTAuNywxLTEKCQkJYzAuNC0wLjMsMC44LTAuNSwxLjMtMC43YzAuNS0wLjIsMS0wLjIsMS41LTAuMmg3LjFsLTAuNSwxLjljLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNGgtMy4yCgkJCWMtMC4zLDAtMC41LDAuMS0wLjYsMC40Yy0wLjEsMC4yLDAsMC40LDAuMSwwLjVjMC4xLDAuMSwwLjMsMC4yLDAuNSwwLjJoNS4xYzAuMiwwLDAuNCwwLDAuNS0wLjFjMC4xLTAuMSwwLjItMC4yLDAuMy0wLjQKCQkJbDAuMS0wLjJMNDMuMSwxMC4yeiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik01OC4zLDQuOWMxLjIsMCwyLjQsMC4zLDMuNSwwLjhjMSwwLjUsMS45LDEuMiwyLjYsMi4xYzAuNywwLjksMS4yLDEuOSwxLjQsM2MwLjMsMS4xLDAuMiwyLjMtMC4xLDMuNAoJCQlsLTEuMyw0LjdjLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNINjBjLTAuNSwwLTEtMC40LTEtMC45YzAtMC4xLDAtMC4yLDAtMC4zbDEuNi01LjcKCQkJYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43Yy0wLjQtMC4yLTAuOC0wLjMtMS4yLTAuM2gtMi45bC0yLjUsOS4xCgkJCWMtMC4xLDAuMy0wLjMsMC42LTAuNiwwLjhjLTAuMywwLjItMC42LDAuMy0xLDAuM2gtMi44Yy0wLjMsMC0wLjYtMC4xLTAuOC0wLjRjLTAuMi0wLjItMC4zLTAuNS0wLjItMC44bDMuOC0xMy45TDU4LjMsNC45eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik03My42LDkuN2MtMC4yLDAuMi0wLjQsMC40LTAuNCwwLjZMNzIsMTQuNWMtMC4xLDAuNCwwLjEsMC44LDAuNSwwLjljMC4xLDAsMC4xLDAsMC4yLDBoMTAuOGwtMC44LDMKCQkJYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMUM4MS41LDE5LjksODEsMjAsODAuNiwyMGgtOS44Yy0wLjcsMC0xLjMtMC4xLTEuOS0wLjRjLTAuNi0wLjMtMS4xLTAuNy0xLjUtMS4yCgkJCWMtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMS0wLjYtMC4xLTEuMywwLjEtMS45bDEuNi01LjdjMC4yLTAuNiwwLjQtMS4yLDAuOC0xLjdjMC43LTEsMS43LTEuOCwyLjktMi4yCgkJCWMwLjYtMC4yLDEuMy0wLjMsMS45LTAuM2g2LjljMC43LDAsMS4zLDAuMSwxLjksMC40YzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yQzg0LjYsNyw4NC45LDcuNiw4NSw4LjJjMC4xLDAuNiwwLjEsMS4zLTAuMSwxLjkKCQkJbC0wLjUsMS43Yy0wLjIsMC43LTAuNiwxLjQtMS4zLDEuOGMtMC42LDAuNS0xLjQsMC43LTIuMSwwLjdoLTcuOGwwLjUtMS44YzAuMS0wLjQsMC40LTAuOCwwLjgtMS4xYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40SDc5CgkJCWMwLjMsMCwwLjUtMC4xLDAuNi0wLjRsMC4xLTAuNGMwLjEtMC4zLTAuMS0wLjYtMC40LTAuN2MwLDAtMC4xLDAtMC4xLDBoLTQuOEM3NCw5LjQsNzMuOCw5LjUsNzMuNiw5Ljd6Ii8+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTgzLjUsMjBsNS4yLTE4LjljMC4xLTAuMywwLjMtMC42LDAuNi0wLjhjMC4zLTAuMiwwLjYtMC4zLDEtMC4zSDkzYzAuMywwLDAuNiwwLjEsMC44LDAuNAoJCQlDOTQsMC42LDk0LjEsMC45LDk0LDEuMmwtMy45LDEzLjljLTAuMiwwLjctMC41LDEuNC0wLjksMmMtMC40LDAuNi0wLjksMS4xLTEuNSwxLjVjLTAuNiwwLjQtMS4yLDAuOC0xLjksMQoJCQlDODUsMTkuOSw4NC4yLDIwLDgzLjUsMjB6Ii8+Cgk8L2c+CjwvZz4KPC9zdmc+","format":"base64","description":"The base64-encoded logo used on black or dark backgrounds. This function **only** accepts the SVG file format.","type":"string"},"forLightBackground":{"type":"string","example":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9InhMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgOTQgMjAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDk0IDIwOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+CjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI+Cgkuc3Qwe2ZpbGw6I0ZGNkMyQzt9Cjwvc3R5bGU+Cjx0aXRsZT5jUGFuZWwgTG9nbyAtIE9yYW5nZTwvdGl0bGU+CjxnIGlkPSJ4TGF5ZXJfMiI+Cgk8ZyBpZD0ieExheWVyXzEtMiI+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTcuOCw0LjloNS45bC0wLjksMy4zYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRINy45Yy0wLjYsMC0xLjIsMC4yLTEuNywwLjUKCQkJYy0wLjUsMC40LTAuOCwwLjktMSwxLjRjLTAuMSwwLjQtMC4xLDAuOSwwLDEuM2MwLjEsMC40LDAuMywwLjcsMC41LDEuMWMwLjIsMC4zLDAuNiwwLjYsMC45LDAuN0M3LDE1LDcuNSwxNS4xLDcuOSwxNS4xaDEuNwoJCQljMC4zLDAsMC42LDAuMSwwLjgsMC40YzAuMiwwLjIsMC4zLDAuNSwwLjIsMC44bC0xLDMuN0g3LjZjLTEuMiwwLTIuNC0wLjMtMy40LTAuOGMtMS0wLjUtMS45LTEuMi0yLjYtMi4xCgkJCWMtMS40LTEuOC0xLjktNC4yLTEuMy02LjRsMC4xLTAuNGMwLjQtMS42LDEuNC0yLjksMi43LTMuOUMzLjgsNiw0LjUsNS42LDUuMyw1LjNDNi4xLDUuMSw2LjksNC45LDcuOCw0Ljl6Ii8+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwLjcsMjBsNS4xLTE4LjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjFDMTcsMC4xLDE3LjUsMCwxOCwwaDUuNGMxLjIsMCwyLjQsMC4zLDMuNCwwLjhjMi4xLDEsMy41LDIuOSw0LDUKCQkJYzAuMywxLjEsMC4yLDIuMy0wLjEsMy40bC0wLjEsMC40Yy0wLjIsMC44LTAuNiwxLjUtMSwyLjJjLTEuNCwyLTMuOCwzLjMtNi4zLDMuM2gtNC43bDAuOS0zLjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjEKCQkJYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40aDEuNWMxLjIsMCwyLjMtMC44LDIuNy0yYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43CgkJCUMyNCw1LDIzLjYsNC45LDIzLjEsNC45aC0yLjlsLTMuOCwxMy42Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRIMTAuN3oiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDMuMSwxMC4ybDAuMS0wLjNjMC0wLjEsMC0wLjItMC4xLTAuM2MtMC4xLTAuMS0wLjItMC4xLTAuMy0wLjFoLTguNGMtMC4zLDAtMC43LTAuMS0xLTAuMgoJCQljLTAuMy0wLjEtMC41LTAuMy0wLjctMC42Yy0wLjItMC4yLTAuMy0wLjUtMC40LTAuOGMtMC4xLTAuMy0wLjEtMC43LDAtMWwwLjUtMS45aDExLjRjMC43LDAsMS4zLDAuMSwxLjksMC40CgkJCWMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMmMwLjQsMC41LDAuNywxLjEsMC44LDEuN2MwLjEsMC42LDAuMSwxLjMsMCwxLjlsLTIuMSw3LjNDNDYsMTksNDQuNiwyMCw0MywyMGwtOC40LDAKCQkJYy0xLjQsMC0yLjctMC42LTMuNi0xLjdjLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjItMC43LTAuMS0xLjQsMC4xLTJsMC4xLTAuNGMwLjEtMC41LDAuMy0wLjksMC42LTEuM2MwLjMtMC40LDAuNi0wLjcsMS0xCgkJCWMwLjQtMC4zLDAuOC0wLjUsMS4zLTAuN2MwLjUtMC4yLDEtMC4yLDEuNS0wLjJoNy4xbC0wLjUsMS45Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRoLTMuMgoJCQljLTAuMywwLTAuNSwwLjEtMC42LDAuNGMtMC4xLDAuMiwwLDAuNCwwLjEsMC41YzAuMSwwLjEsMC4zLDAuMiwwLjUsMC4yaDUuMWMwLjIsMCwwLjQsMCwwLjUtMC4xYzAuMS0wLjEsMC4yLTAuMiwwLjMtMC40CgkJCWwwLjEtMC4yTDQzLjEsMTAuMnoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTguMyw0LjljMS4yLDAsMi40LDAuMywzLjUsMC44YzEsMC41LDEuOSwxLjIsMi42LDIuMWMwLjcsMC45LDEuMiwxLjksMS40LDNjMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjQKCQkJbC0xLjMsNC43Yy0wLjEsMC4zLTAuMywwLjYtMC42LDAuOGMtMC4zLDAuMi0wLjYsMC4zLTEsMC4zSDYwYy0wLjUsMC0xLTAuNC0xLTAuOWMwLTAuMSwwLTAuMiwwLTAuM2wxLjYtNS43CgkJCWMwLjEtMC40LDAuMS0wLjgsMC0xLjJjLTAuMS0wLjQtMC4zLTAuNy0wLjUtMS4xYy0wLjItMC4zLTAuNi0wLjYtMC45LTAuN2MtMC40LTAuMi0wLjgtMC4zLTEuMi0wLjNoLTIuOWwtMi41LDkuMQoJCQljLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNoLTIuOGMtMC4zLDAtMC42LTAuMS0wLjgtMC40Yy0wLjItMC4yLTAuMy0wLjUtMC4yLTAuOGwzLjgtMTMuOUw1OC4zLDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNzMuNiw5LjdjLTAuMiwwLjItMC40LDAuNC0wLjQsMC42TDcyLDE0LjVjLTAuMSwwLjQsMC4xLDAuOCwwLjUsMC45YzAuMSwwLDAuMSwwLDAuMiwwaDEwLjhsLTAuOCwzCgkJCWMtMC4xLDAuNC0wLjQsMC44LTAuOCwxLjFDODEuNSwxOS45LDgxLDIwLDgwLjYsMjBoLTkuOGMtMC43LDAtMS4zLTAuMS0xLjktMC40Yy0wLjYtMC4zLTEuMS0wLjctMS41LTEuMgoJCQljLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjEtMC42LTAuMS0xLjMsMC4xLTEuOWwxLjYtNS43YzAuMi0wLjYsMC40LTEuMiwwLjgtMS43YzAuNy0xLDEuNy0xLjgsMi45LTIuMgoJCQljMC42LTAuMiwxLjMtMC4zLDEuOS0wLjNoNi45YzAuNywwLDEuMywwLjEsMS45LDAuNGMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMkM4NC42LDcsODQuOSw3LjYsODUsOC4yYzAuMSwwLjYsMC4xLDEuMy0wLjEsMS45CgkJCWwtMC41LDEuN2MtMC4yLDAuNy0wLjYsMS40LTEuMywxLjhjLTAuNiwwLjUtMS40LDAuNy0yLjEsMC43aC03LjhsMC41LTEuOGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMWMwLjQtMC4zLDAuOC0wLjQsMS4zLTAuNEg3OQoJCQljMC4zLDAsMC41LTAuMSwwLjYtMC40bDAuMS0wLjRjMC4xLTAuMy0wLjEtMC42LTAuNC0wLjdjMCwwLTAuMSwwLTAuMSwwaC00LjhDNzQsOS40LDczLjgsOS41LDczLjYsOS43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik04My41LDIwbDUuMi0xOC45YzAuMS0wLjMsMC4zLTAuNiwwLjYtMC44YzAuMy0wLjIsMC42LTAuMywxLTAuM0g5M2MwLjMsMCwwLjYsMC4xLDAuOCwwLjQKCQkJQzk0LDAuNiw5NC4xLDAuOSw5NCwxLjJsLTMuOSwxMy45Yy0wLjIsMC43LTAuNSwxLjQtMC45LDJjLTAuNCwwLjYtMC45LDEuMS0xLjUsMS41Yy0wLjYsMC40LTEuMiwwLjgtMS45LDEKCQkJQzg1LDE5LjksODQuMiwyMCw4My41LDIweiIvPgoJPC9nPgo8L2c+Cjwvc3ZnPgo=","format":"base64","description":"The base64-encoded logo used on white or light backgrounds. This function **only** accepts the SVG file format."},"description":{"type":"string","example":"The orange logo for cPanel.","description":"The description of the logo used for accessibility requirements."}},"description":"Logo information used to add your custom logo to the interface."}},"type":"object"},"help":{"description":"Optional help information.","properties":{"url":{"description":"URL to the companies customer support site. This url will replace the default help link in the footer if defined.","format":"url","example":"https://hosting.com/get-help","type":"string"}},"type":"object"}},"type":"object"}}}}],"summary":"Update customization data","x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"true","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  update_customizations \\\n  application='cpanel' \\\n  theme='jupiter' \\\n  data='{\"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\"}}'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/update_customizations?api.version=1&application=cpanel&theme=jupiter&data=%7B%22brand%22%3A%7B%22colors%22%3A%7B%22accent%22%3A%22%2300FF00%22%2C%22primary%22%3A%22%23961218%22%7D%2C%22favicon%22%3A%22AAABAAEAICACAAEAAQAwAQAAFgAAACgAAAAgAAAAQAAAAAEAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACanZoAAAAAAP%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%22%2C%22logo%22%3A%7B%22description%22%3A%22The%20orange%20logo%20for%20cPanel.%22%2C%22forDarkBackground%22%3A%22PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA5NCAyMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTQgMjA7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRkZGRkZGO30KPC9zdHlsZT4KPHRpdGxlPmNQYW5lbCBMb2dvIC0gV2hpdGU8L3RpdGxlPgo8ZyBpZD0iTGF5ZXJfMiI%2BCgk8ZyBpZD0iTGF5ZXJfMS0yIj4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNy44LDQuOWg1LjlsLTAuOSwzLjNjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEg3LjljLTAuNiwwLTEuMiwwLjItMS43LDAuNQoJCQljLTAuNSwwLjQtMC44LDAuOS0xLDEuNGMtMC4xLDAuNC0wLjEsMC45LDAsMS4zYzAuMSwwLjQsMC4zLDAuNywwLjUsMS4xYzAuMiwwLjMsMC42LDAuNiwwLjksMC43QzcsMTUsNy41LDE1LjEsNy45LDE1LjFoMS43CgkJCWMwLjMsMCwwLjYsMC4xLDAuOCwwLjRjMC4yLDAuMiwwLjMsMC41LDAuMiwwLjhsLTEsMy43SDcuNmMtMS4yLDAtMi40LTAuMy0zLjQtMC44Yy0xLTAuNS0xLjktMS4yLTIuNi0yLjEKCQkJYy0xLjQtMS44LTEuOS00LjItMS4zLTYuNGwwLjEtMC40YzAuNC0xLjYsMS40LTIuOSwyLjctMy45QzMuOCw2LDQuNSw1LjYsNS4zLDUuM0M2LjEsNS4xLDYuOSw0LjksNy44LDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMTAuNywyMGw1LjEtMTguNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMUMxNywwLjEsMTcuNSwwLDE4LDBoNS40YzEuMiwwLDIuNCwwLjMsMy40LDAuOGMyLjEsMSwzLjUsMi45LDQsNQoJCQljMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjRsLTAuMSwwLjRjLTAuMiwwLjgtMC42LDEuNS0xLDIuMmMtMS40LDItMy44LDMuMy02LjMsMy4zaC00LjdsMC45LTMuNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMQoJCQljMC40LTAuMywwLjgtMC40LDEuMy0wLjRoMS41YzEuMiwwLDIuMy0wLjgsMi43LTJjMC4xLTAuNCwwLjEtMC44LDAtMS4yYy0wLjEtMC40LTAuMy0wLjctMC41LTEuMWMtMC4yLTAuMy0wLjYtMC42LTAuOS0wLjcKCQkJQzI0LDUsMjMuNiw0LjksMjMuMSw0LjloLTIuOWwtMy44LDEzLjZjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEgxMC43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00My4xLDEwLjJsMC4xLTAuM2MwLTAuMSwwLTAuMi0wLjEtMC4zYy0wLjEtMC4xLTAuMi0wLjEtMC4zLTAuMWgtOC40Yy0wLjMsMC0wLjctMC4xLTEtMC4yCgkJCWMtMC4zLTAuMS0wLjUtMC4zLTAuNy0wLjZjLTAuMi0wLjItMC4zLTAuNS0wLjQtMC44Yy0wLjEtMC4zLTAuMS0wLjcsMC0xbDAuNS0xLjloMTEuNGMwLjcsMCwxLjMsMC4xLDEuOSwwLjQKCQkJYzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yYzAuNCwwLjUsMC43LDEuMSwwLjgsMS43YzAuMSwwLjYsMC4xLDEuMywwLDEuOWwtMi4xLDcuM0M0NiwxOSw0NC42LDIwLDQzLDIwbC04LjQsMAoJCQljLTEuNCwwLTIuNy0wLjYtMy42LTEuN2MtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMi0wLjctMC4xLTEuNCwwLjEtMmwwLjEtMC40YzAuMS0wLjUsMC4zLTAuOSwwLjYtMS4zYzAuMy0wLjQsMC42LTAuNywxLTEKCQkJYzAuNC0wLjMsMC44LTAuNSwxLjMtMC43YzAuNS0wLjIsMS0wLjIsMS41LTAuMmg3LjFsLTAuNSwxLjljLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNGgtMy4yCgkJCWMtMC4zLDAtMC41LDAuMS0wLjYsMC40Yy0wLjEsMC4yLDAsMC40LDAuMSwwLjVjMC4xLDAuMSwwLjMsMC4yLDAuNSwwLjJoNS4xYzAuMiwwLDAuNCwwLDAuNS0wLjFjMC4xLTAuMSwwLjItMC4yLDAuMy0wLjQKCQkJbDAuMS0wLjJMNDMuMSwxMC4yeiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik01OC4zLDQuOWMxLjIsMCwyLjQsMC4zLDMuNSwwLjhjMSwwLjUsMS45LDEuMiwyLjYsMi4xYzAuNywwLjksMS4yLDEuOSwxLjQsM2MwLjMsMS4xLDAuMiwyLjMtMC4xLDMuNAoJCQlsLTEuMyw0LjdjLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNINjBjLTAuNSwwLTEtMC40LTEtMC45YzAtMC4xLDAtMC4yLDAtMC4zbDEuNi01LjcKCQkJYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43Yy0wLjQtMC4yLTAuOC0wLjMtMS4yLTAuM2gtMi45bC0yLjUsOS4xCgkJCWMtMC4xLDAuMy0wLjMsMC42LTAuNiwwLjhjLTAuMywwLjItMC42LDAuMy0xLDAuM2gtMi44Yy0wLjMsMC0wLjYtMC4xLTAuOC0wLjRjLTAuMi0wLjItMC4zLTAuNS0wLjItMC44bDMuOC0xMy45TDU4LjMsNC45eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik03My42LDkuN2MtMC4yLDAuMi0wLjQsMC40LTAuNCwwLjZMNzIsMTQuNWMtMC4xLDAuNCwwLjEsMC44LDAuNSwwLjljMC4xLDAsMC4xLDAsMC4yLDBoMTAuOGwtMC44LDMKCQkJYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMUM4MS41LDE5LjksODEsMjAsODAuNiwyMGgtOS44Yy0wLjcsMC0xLjMtMC4xLTEuOS0wLjRjLTAuNi0wLjMtMS4xLTAuNy0xLjUtMS4yCgkJCWMtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMS0wLjYtMC4xLTEuMywwLjEtMS45bDEuNi01LjdjMC4yLTAuNiwwLjQtMS4yLDAuOC0xLjdjMC43LTEsMS43LTEuOCwyLjktMi4yCgkJCWMwLjYtMC4yLDEuMy0wLjMsMS45LTAuM2g2LjljMC43LDAsMS4zLDAuMSwxLjksMC40YzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yQzg0LjYsNyw4NC45LDcuNiw4NSw4LjJjMC4xLDAuNiwwLjEsMS4zLTAuMSwxLjkKCQkJbC0wLjUsMS43Yy0wLjIsMC43LTAuNiwxLjQtMS4zLDEuOGMtMC42LDAuNS0xLjQsMC43LTIuMSwwLjdoLTcuOGwwLjUtMS44YzAuMS0wLjQsMC40LTAuOCwwLjgtMS4xYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40SDc5CgkJCWMwLjMsMCwwLjUtMC4xLDAuNi0wLjRsMC4xLTAuNGMwLjEtMC4zLTAuMS0wLjYtMC40LTAuN2MwLDAtMC4xLDAtMC4xLDBoLTQuOEM3NCw5LjQsNzMuOCw5LjUsNzMuNiw5Ljd6Ii8%2BCgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTgzLjUsMjBsNS4yLTE4LjljMC4xLTAuMywwLjMtMC42LDAuNi0wLjhjMC4zLTAuMiwwLjYtMC4zLDEtMC4zSDkzYzAuMywwLDAuNiwwLjEsMC44LDAuNAoJCQlDOTQsMC42LDk0LjEsMC45LDk0LDEuMmwtMy45LDEzLjljLTAuMiwwLjctMC41LDEuNC0wLjksMmMtMC40LDAuNi0wLjksMS4xLTEuNSwxLjVjLTAuNiwwLjQtMS4yLDAuOC0xLjksMQoJCQlDODUsMTkuOSw4NC4yLDIwLDgzLjUsMjB6Ii8%2BCgk8L2c%2BCjwvZz4KPC9zdmc%2B%22%2C%22forLightBackground%22%3A%22PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9InhMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgOTQgMjAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDk0IDIwOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGNkMyQzt9Cjwvc3R5bGU%2BCjx0aXRsZT5jUGFuZWwgTG9nbyAtIE9yYW5nZTwvdGl0bGU%2BCjxnIGlkPSJ4TGF5ZXJfMiI%2BCgk8ZyBpZD0ieExheWVyXzEtMiI%2BCgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTcuOCw0LjloNS45bC0wLjksMy4zYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRINy45Yy0wLjYsMC0xLjIsMC4yLTEuNywwLjUKCQkJYy0wLjUsMC40LTAuOCwwLjktMSwxLjRjLTAuMSwwLjQtMC4xLDAuOSwwLDEuM2MwLjEsMC40LDAuMywwLjcsMC41LDEuMWMwLjIsMC4zLDAuNiwwLjYsMC45LDAuN0M3LDE1LDcuNSwxNS4xLDcuOSwxNS4xaDEuNwoJCQljMC4zLDAsMC42LDAuMSwwLjgsMC40YzAuMiwwLjIsMC4zLDAuNSwwLjIsMC44bC0xLDMuN0g3LjZjLTEuMiwwLTIuNC0wLjMtMy40LTAuOGMtMS0wLjUtMS45LTEuMi0yLjYtMi4xCgkJCWMtMS40LTEuOC0xLjktNC4yLTEuMy02LjRsMC4xLTAuNGMwLjQtMS42LDEuNC0yLjksMi43LTMuOUMzLjgsNiw0LjUsNS42LDUuMyw1LjNDNi4xLDUuMSw2LjksNC45LDcuOCw0Ljl6Ii8%2BCgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwLjcsMjBsNS4xLTE4LjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjFDMTcsMC4xLDE3LjUsMCwxOCwwaDUuNGMxLjIsMCwyLjQsMC4zLDMuNCwwLjhjMi4xLDEsMy41LDIuOSw0LDUKCQkJYzAuMywxLjEsMC4yLDIuMy0wLjEsMy40bC0wLjEsMC40Yy0wLjIsMC44LTAuNiwxLjUtMSwyLjJjLTEuNCwyLTMuOCwzLjMtNi4zLDMuM2gtNC43bDAuOS0zLjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjEKCQkJYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40aDEuNWMxLjIsMCwyLjMtMC44LDIuNy0yYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43CgkJCUMyNCw1LDIzLjYsNC45LDIzLjEsNC45aC0yLjlsLTMuOCwxMy42Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRIMTAuN3oiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDMuMSwxMC4ybDAuMS0wLjNjMC0wLjEsMC0wLjItMC4xLTAuM2MtMC4xLTAuMS0wLjItMC4xLTAuMy0wLjFoLTguNGMtMC4zLDAtMC43LTAuMS0xLTAuMgoJCQljLTAuMy0wLjEtMC41LTAuMy0wLjctMC42Yy0wLjItMC4yLTAuMy0wLjUtMC40LTAuOGMtMC4xLTAuMy0wLjEtMC43LDAtMWwwLjUtMS45aDExLjRjMC43LDAsMS4zLDAuMSwxLjksMC40CgkJCWMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMmMwLjQsMC41LDAuNywxLjEsMC44LDEuN2MwLjEsMC42LDAuMSwxLjMsMCwxLjlsLTIuMSw3LjNDNDYsMTksNDQuNiwyMCw0MywyMGwtOC40LDAKCQkJYy0xLjQsMC0yLjctMC42LTMuNi0xLjdjLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjItMC43LTAuMS0xLjQsMC4xLTJsMC4xLTAuNGMwLjEtMC41LDAuMy0wLjksMC42LTEuM2MwLjMtMC40LDAuNi0wLjcsMS0xCgkJCWMwLjQtMC4zLDAuOC0wLjUsMS4zLTAuN2MwLjUtMC4yLDEtMC4yLDEuNS0wLjJoNy4xbC0wLjUsMS45Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRoLTMuMgoJCQljLTAuMywwLTAuNSwwLjEtMC42LDAuNGMtMC4xLDAuMiwwLDAuNCwwLjEsMC41YzAuMSwwLjEsMC4zLDAuMiwwLjUsMC4yaDUuMWMwLjIsMCwwLjQsMCwwLjUtMC4xYzAuMS0wLjEsMC4yLTAuMiwwLjMtMC40CgkJCWwwLjEtMC4yTDQzLjEsMTAuMnoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTguMyw0LjljMS4yLDAsMi40LDAuMywzLjUsMC44YzEsMC41LDEuOSwxLjIsMi42LDIuMWMwLjcsMC45LDEuMiwxLjksMS40LDNjMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjQKCQkJbC0xLjMsNC43Yy0wLjEsMC4zLTAuMywwLjYtMC42LDAuOGMtMC4zLDAuMi0wLjYsMC4zLTEsMC4zSDYwYy0wLjUsMC0xLTAuNC0xLTAuOWMwLTAuMSwwLTAuMiwwLTAuM2wxLjYtNS43CgkJCWMwLjEtMC40LDAuMS0wLjgsMC0xLjJjLTAuMS0wLjQtMC4zLTAuNy0wLjUtMS4xYy0wLjItMC4zLTAuNi0wLjYtMC45LTAuN2MtMC40LTAuMi0wLjgtMC4zLTEuMi0wLjNoLTIuOWwtMi41LDkuMQoJCQljLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNoLTIuOGMtMC4zLDAtMC42LTAuMS0wLjgtMC40Yy0wLjItMC4yLTAuMy0wLjUtMC4yLTAuOGwzLjgtMTMuOUw1OC4zLDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNzMuNiw5LjdjLTAuMiwwLjItMC40LDAuNC0wLjQsMC42TDcyLDE0LjVjLTAuMSwwLjQsMC4xLDAuOCwwLjUsMC45YzAuMSwwLDAuMSwwLDAuMiwwaDEwLjhsLTAuOCwzCgkJCWMtMC4xLDAuNC0wLjQsMC44LTAuOCwxLjFDODEuNSwxOS45LDgxLDIwLDgwLjYsMjBoLTkuOGMtMC43LDAtMS4zLTAuMS0xLjktMC40Yy0wLjYtMC4zLTEuMS0wLjctMS41LTEuMgoJCQljLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjEtMC42LTAuMS0xLjMsMC4xLTEuOWwxLjYtNS43YzAuMi0wLjYsMC40LTEuMiwwLjgtMS43YzAuNy0xLDEuNy0xLjgsMi45LTIuMgoJCQljMC42LTAuMiwxLjMtMC4zLDEuOS0wLjNoNi45YzAuNywwLDEuMywwLjEsMS45LDAuNGMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMkM4NC42LDcsODQuOSw3LjYsODUsOC4yYzAuMSwwLjYsMC4xLDEuMy0wLjEsMS45CgkJCWwtMC41LDEuN2MtMC4yLDAuNy0wLjYsMS40LTEuMywxLjhjLTAuNiwwLjUtMS40LDAuNy0yLjEsMC43aC03LjhsMC41LTEuOGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMWMwLjQtMC4zLDAuOC0wLjQsMS4zLTAuNEg3OQoJCQljMC4zLDAsMC41LTAuMSwwLjYtMC40bDAuMS0wLjRjMC4xLTAuMy0wLjEtMC42LTAuNC0wLjdjMCwwLTAuMSwwLTAuMSwwaC00LjhDNzQsOS40LDczLjgsOS41LDczLjYsOS43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik04My41LDIwbDUuMi0xOC45YzAuMS0wLjMsMC4zLTAuNiwwLjYtMC44YzAuMy0wLjIsMC42LTAuMywxLTAuM0g5M2MwLjMsMCwwLjYsMC4xLDAuOCwwLjQKCQkJQzk0LDAuNiw5NC4xLDAuOSw5NCwxLjJsLTMuOSwxMy45Yy0wLjIsMC43LTAuNSwxLjQtMC45LDJjLTAuNCwwLjYtMC45LDEuMS0xLjUsMS41Yy0wLjYsMC40LTEuMiwwLjgtMS45LDEKCQkJQzg1LDE5LjksODQuMiwyMCw4My41LDIweiIvPgoJPC9nPgo8L2c%2BCjwvc3ZnPgo%3D%22%7D%7D%2C%22documentation%22%3A%7B%22url%22%3A%22https%3A%2F%2Fhosting.com%2Fdocumentation%22%7D%2C%22help%22%3A%7B%22url%22%3A%22https%3A%2F%2Fhosting.com%2Fget-help%22%7D%7D","label":"URL","lang":"HTTP"}],"tags":["Customizations"]}}},"x-tagGroups":[{"name":"Customizations","tags":["Brand","Customizations"]}]},"unset_all_service_proxy_backends":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.91.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Services"],"name":"Server Administration"}],"paths":{"/unset_all_service_proxy_backends":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Remove cPanel account service proxying","tags":["Services"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  unset_all_service_proxy_backends \\\n  username='username'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/unset_all_service_proxy_backends?api.version=1&username=username"}],"x-cpanel-available-version":"90","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"unset_all_service_proxy_backends"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"operationId":"unset_all_service_proxy_backends","description":"This function removes 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),\nthis function will also unset **all** service proxying for the cPanel account on the\n[child node](https://go.cpanel.net/cPanelGlossary#child-node).\n* If the [Web Server](https://go.cpanel.net/howtouseserverprofiles#roles) role is active on\nthe server, this function rebuilds the cPanel user's web virtual hosts (vhosts) and restarts\nthe web server.\n* If the system **cannot** rebuild the cPanel user's vhosts, the API call will still succeed.\nHowever, the function returns a failure warning in the metadata.\n* To set a service proxying for a cPanel account, use the WHM API 1\n`set_service_proxy_backends` function.","parameters":[{"required":"true","in":"query","name":"username","schema":{"type":"string","example":"username","format":"username"},"description":"The cPanel account's username."}]}}},"tags":[{"description":"Server Administration / Services","name":"Services"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"savemxs":{"openapi":"3.0.2","info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"Domain Management","description":"DNS / Domain Management"}],"paths":{"/savemxs":{"get":{"x-codeSamples":[{"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":"CLI","lang":"Shell"},{"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"}],"tags":["DNS","Domain Management"],"summary":"Create mail exchanger record","x-cpanel-api-version":"WHM API 1","operationId":"savemxs","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.","parameters":[{"required":"true","in":"query","name":"domain","schema":{"example":"example.com","format":"domain","type":"string"},"description":"The zone record's domain."},{"name":"name","in":"query","required":"true","description":"The record name.","schema":{"example":"mail.example.com","type":"string"}},{"description":"The domain's mail exchanger.","schema":{"format":"domain","example":"mail.example.com","type":"string"},"name":"exchange","in":"query","required":"true"},{"in":"query","name":"preference","required":"true","description":"The MX record's priority order.\n\n**Note:**\n\nLower numbers indicate a higher priority order.","schema":{"minimum":"1","type":"integer","example":"20"}},{"schema":{"default":"IN","example":"IN","type":"string"},"description":"The record's class.","required":"false","in":"query","name":"class"},{"description":"The record's Time To Live (TTL) in seconds.","schema":{"example":"14400","default":"14400","type":"integer","minimum":"1"},"name":"ttl","in":"query","required":"false"}],"x-cpanel-available-version":"11.28","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The 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.","example":"1","enum":["0","1"],"type":"integer"},"command":{"description":"The method name called.","example":"savemxs","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}]},"get_unique_recipient_count_per_sender_for_user":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/get_unique_recipient_count_per_sender_for_user":{"get":{"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"},{"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","lang":"HTTP","label":"URL"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Return cPanel account unique email recipients","x-cpanel-api-version":"WHM API 1","parameters":[{"schema":{"example":"username","type":"string"},"description":"The system user's username.","required":"true","in":"query","name":"user"},{"schema":{"format":"unix_timestamp","example":"1550872800","type":"integer"},"description":"A start time to query.","required":"true","in":"query","name":"start_time"},{"name":"end_time","in":"query","required":"true","description":"An end time to query.","schema":{"example":"1550923200","format":"unix_timestamp","type":"integer"}}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","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":{"unique_recipient_count":{"description":"The number of unique recipients that the email account sent mail to.","example":"51","minimum":"1","type":"integer"},"sender":{"type":"string","description":"The user's email address.","example":"username@example.com"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"description":"The method name called.","example":"get_unique_recipient_count_per_sender_for_user","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"80"}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}]},"sethostname":{"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / System Information","name":"System Information"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Server Administration","tags":["System Information"]}],"paths":{"/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":[{"name":"hostname","in":"query","required":"true","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`.  ","schema":{"type":"string","format":"hostname","example":"hostname.example.com"}}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"output":{"properties":{"messages":{"type":"string","description":"Any of the function's output messages.","example":"Updating cPanel license...Done. Update succeeded."},"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","description":"A list of the function's output."},"reason":{"description":"The 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&#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 />","type":"string"},"command":{"type":"string","example":"sethostname","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  sethostname \\\n  hostname='hostname.example.com'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/sethostname?api.version=1&hostname=hostname.example.com","lang":"HTTP","label":"URL"}],"tags":["Server Administration","System Information"],"summary":"Update server's hostname","x-cpanel-api-version":"WHM API 1"}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"}},"generate_mobileconfig":{"paths":{"/generate_mobileconfig":{"get":{"summary":"Create email account mobile profile configuration","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  generate_mobileconfig \\\n  account='username' \\\n  use_ssl='1'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/generate_mobileconfig?api.version=1&account=username&use_ssl=1"}],"tags":["Mail","Mail Server Settings"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"type":"string","format":"base64","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"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"generate_mobileconfig","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.52","parameters":[{"name":"account","in":"query","required":"true","description":"The email account's username.","schema":{"type":"string","example":"username"}},{"schema":{"example":"1","enum":["0","1"],"type":"integer"},"description":"Whether to use an SSL-encrypted connection.\n* `1` — Use an SSL-encrypted connnection.\n* `0` — Do **not** use an SSL-encrypted connection.","required":"true","name":"use_ssl","in":"query"},{"in":"query","name":"selected_account_services","required":"false","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.","schema":{"type":"string","example":"email","enum":["caldav","carddav","email"],"default":"email,caldav,carddav"}}],"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"}}},"x-tagGroups":[{"tags":["Mail Server Settings"],"name":"Mail"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"api_token_get_details":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"Metadata":{"type":"object","properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"api_token_get_details","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` – Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"TokenDetails":{"properties":{"create_time":{"type":"integer","format":"unix_timestamp","description":"The API token's creation time.","example":"1483625276"},"expires_at":{"type":"integer","nullable":"true","example":"1609372800","format":"unix_timestamp","description":"The API token's expiration time.\n\n**Note:**\n\nA `null` value means that the API token does **not** expire."},"name":{"description":"The API token's name.","example":"example","type":"string"},"whitelist_ips":{"nullable":"true","example":["192.0.2.1","192.0.2.2","192.0.2.8/29","fc00:abcd:0000:0000:0000:0000:0000:000f","2620:0000:28a4:0000:0000:0000:0000:0000/48"],"items":{"anyOf":[{"type":"string","format":"ipv4"},{"format":"ipv6","type":"string"},{"type":"string","format":"cidr"}]},"description":"List of remote IP or CIDR IP ranges this token may be used from.","type":"array"},"acls":{"example":["create-acct","kill-acct","list-accts"],"items":{"type":"string"},"description":"A list of privileges assigned to the token.","type":"array"}},"type":"object"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.97.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"API Development Tools / API Token Management","name":"API Token Management"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"name":"API Development Tools","tags":["API Token Management"]}],"paths":{"/api_token_get_details":{"get":{"summary":"Look up API token details","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  api_token_get_details \\\n  token=GVJWD78FF12NMBFKYKPS9BJ483C0XSQH\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/api_token_get_details?api.version=1&token=GVJWD78FF12NMBFKYKPS9BJ483C0XSQH","lang":"HTTP","label":"URL"}],"tags":["Authentication","API Token Management"],"x-cpanel-available-version":"98","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"anyOf":[{"properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"data":{"allOf":[{"description":"The API token’s details. Only present if the system recognizes the given `token`."},{"$ref":"#/components/schemas/TokenDetails"}]}},"title":"Token Recognized","type":"object"},{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"}},"title":"Token Unrecognized"}]}}}}},"description":"This function looks up an API token’s details based on the token itself.","operationId":"api_token_get_details","parameters":[{"description":"The API token.","schema":{"type":"string","example":"GVJWD78FF12NMBFKYKPS9BJ483C0XSQH"},"in":"query","name":"token","required":"true"}]}}}},"disable_cpgreylist":{"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"paths":{"/disable_cpgreylist":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Disable Greylisting","tags":["Greylisting","Spam Protection (Greylisting)"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  disable_cpgreylist\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_cpgreylist?api.version=1","lang":"HTTP","label":"URL"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"disable_cpgreylist","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"example":"OK","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.","type":"string"}}}}}}}}},"x-cpanel-available-version":"11.50","parameters":[],"description":"This function disables Greylisting.","operationId":"disable_cpgreylist"}}},"tags":[{"name":"Greylisting","description":"The Greylisting module for WHM API 1."},{"description":"Mail / Spam Protection (Greylisting)","name":"Spam Protection (Greylisting)"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"addpkgext":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"tags":["Hosting Plan Extensions"],"name":"Hosting Plans"}],"paths":{"/addpkgext":{"get":{"summary":"Add hosting plan extension","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  addpkgext \\\n  name='package1' \\\n  _PACKAGE_EXTENSIONS='extension1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/addpkgext?api.version=1&name=package1&_PACKAGE_EXTENSIONS=extension1","lang":"HTTP","label":"URL"}],"tags":["Packages","Hosting Plan Extensions"],"x-cpanel-available-version":"68","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"pkg":{"description":"The hosting plan's name.","example":"package1","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"command":{"type":"string","example":"addpkgext","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}}}},"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":[{"schema":{"type":"string","example":"package1"},"description":"The hosting plan's name.\n\n**Note:**\n\nYou **cannot** use the `extensions` name for a hosting plan.","required":"true","name":"name","in":"query"},{"name":"_PACKAGE_EXTENSIONS","in":"query","required":"true","style":"spaceDelimited","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":{"single":{"summary":"Add a single package extension.","value":"extension1"},"multiple":{"summary":"Add multiple package extensions.","value":"extension1 extension2 extension3"}},"explode":"false","schema":{"type":"string"}}]}}},"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Hosting Plan Extensions","description":"Hosting Plans / Hosting Plan Extensions"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}]},"delete_hook":{"x-tagGroups":[{"name":"Integrations","tags":["Scripts Hooks"]}],"paths":{"/delete_hook":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","example":"delete_hook","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.32","parameters":[{"in":"query","name":"id","required":"true","description":"The script hook's ID.\n\n**Note:**\n\nTo retrieve a hook's ID, use the WHM API 1 `list_hooks` function.","schema":{"type":"string","example":"HzEpGvT6QGUYwxuX3hWB8AUq"}}],"operationId":"delete_hook","description":"This function removes a script hook.","x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_hook?api.version=1&id=HzEpGvT6QGUYwxuX3hWB8AUq","lang":"HTTP","label":"URL"}]}}},"tags":[{"description":"The Script Hooks module for WHM API 1.","name":"Script Hooks"},{"description":"Integrations / Scripts Hooks","name":"Scripts Hooks"}],"servers":[{"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."}},"description":"A server running WHM."}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"openapi":"3.0.2"},"get_tcp4_sockets":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Connections","name":"Connections"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"tags":["Connections"],"name":"Server Administration"}],"paths":{"/get_tcp4_sockets":{"get":{"x-cpanel-available-version":"80","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payload":{"type":"array","description":"An array of objects that contains the status of the system's TCP IPv4 sockets.","items":{"type":"object","properties":{"src":{"example":"10.0.0.1","description":"The source IPv4 address.","format":"ipv4","type":"string"},"state":{"minimum":"1","type":"integer","example":"10","description":"The socket's current state, in the Linux kernel's numeric format."},"dst":{"description":"The destination IPv4 address.","format":"ipv4","example":"10.0.0.2","type":"string"},"sport":{"type":"integer","description":"The source port number.","example":"2087"},"rqueue":{"description":"The number of bytes in the socket's read buffer.","format":"bytes","example":"0","type":"integer"},"uid":{"description":"The socket's user ID (UID).","example":"102","type":"integer","minimum":"1"},"wqueue":{"type":"integer","example":"45","format":"bytes","description":"The number of bytes the system is waiting to send."},"inode":{"example":"27171","description":"The inode number the Linux kernel assigned to the socket.","type":"integer","minimum":"1"},"dport":{"type":"integer","example":"443","description":"The source port that the Linux kernel reports for the socket."}}}}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","description":"The method name called.","example":"get_tcp4_sockets"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}}}}}}},"operationId":"get_tcp4_sockets","description":"This function returns data about the system's transmission control protocol (TCP) IPv4 sockets.","parameters":[],"summary":"Return TCP IPv4 sockets data","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_tcp4_sockets\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_tcp4_sockets?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Server Administration","Connections"]}}}},"is_role_enabled":{"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Server Profiles","description":"Server Administration / Server Profiles"}],"paths":{"/is_role_enabled":{"get":{"tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  is_role_enabled \\\n  role='FTP'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/is_role_enabled?api.version=1&role=FTP","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return whether server role is enabled","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":[{"schema":{"type":"string","enum":["CalendarContact","DNS","FileStorage","FTP","MailLocal","MailReceive","MailRelay","MailSend","MySQL","MySQLClient","Postgres","PostgresClient","SpamFilter","WebDisk","Webmail","WebServer"],"example":"FTP"},"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.","required":"true","name":"role","in":"query"}],"x-cpanel-available-version":"76","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"enabled":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether a role is enabled or disabled.\n* `1` - Enabled.\n* `0` - Disabled."}}},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"is_role_enabled"},"result":{"example":"1","enum":["1","0"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Server Profiles"],"name":"Server Administration"}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"set_public_contact":{"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"name":"Account Settings","description":"Resellers / Account Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Account Settings"],"name":"Resellers"}],"paths":{"/set_public_contact":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_public_contact?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"68","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","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"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"set_public_contact","description":"The method name called."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}}},"type":"object"}}}}},"operationId":"set_public_contact","description":"This function sets an account's public contact information.","parameters":[{"description":"The public contact name of the reseller. If you do not use this\nparameter, the system retains the current setting.","schema":{"type":"string","example":"Bob's Hosting"},"in":"query","name":"name","required":"false"},{"in":"query","name":"url","required":"false","description":"The public contact URL. If you do not use this parameter, the\nsystem retains the current setting.","schema":{"type":"string","example":"https://bobshosting.net"}}]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"}},"set_digest_auth":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"name":"Account Management","description":"Accounts / Account Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Account Management"],"name":"Accounts"}],"paths":{"/set_digest_auth":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Enable or disable Digest Authentication","tags":["Accounts","Account Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  set_digest_auth \\\n  user='username' \\\n  password='123456luggage' \\\n  enabledigest='1'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_digest_auth?api.version=1&user=username&password=123456luggage&enabledigest=1"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_digest_auth","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details."},"reason":{"example":"Digest Authentication enabled.","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.","type":"string"}}}}}}}}},"description":"This function enables or disables Digest Authentication for an account. Windows Vista®,\nWindows® 7, and Windows® 8 requires that you enable Digest Authentication support in order\nto access your [Web Disk](https://docs.cpanel.net/cpanel/files/web-disk/) over a clear text,\nunencrypted connection.\n\n**Note:**\n\nIf the server has an SSL certificate that a recognized certificate authority signed and you\ncan make an SSL connection over port `2078`, you do **not** need to enable Digest Authentication.","operationId":"set_digest_auth","parameters":[{"description":"The account's username.","schema":{"example":"username","type":"string"},"in":"query","name":"user","required":"true"},{"schema":{"example":"123456luggage","type":"string"},"description":"The account's password.","required":"true","name":"password","in":"query"},{"in":"query","name":"enabledigest","required":"true","description":"Whether to enable Digest Authentication for the account.\n\n* `1` — Enable.\n* `0` — Disable.","schema":{"example":"1","enum":["0","1"],"type":"integer"}},{"schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether to enable Digest Authentication for the account. This is an alias for the `enabledigest` parameter.\n\n* `1` — Enable.\n* `0` — Disable.","required":"false","name":"digestauth","in":"query"}]}}}},"create_user_session":{"paths":{"/create_user_session":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  create_user_session \\\n  user='user@example.com' \\\n  service='cpaneld'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/create_user_session?api.version=1&user=user%40example.com&service=cpaneld","label":"URL","lang":"HTTP"}],"tags":["Server Administration","Session"],"summary":"Create a temporary user session","x-cpanel-api-version":"WHM API 1","description":"This function creates a new temporary user session for a specified service.\nThis allows users with WHM access to log in to third-party applications\n(for example, billing systems) without storing the account password.\n\n**Note:**\n\n* The system destroys the temporary session after 15 minutes of inactivity.\n* For more information about the Single Sign On feature, read our\n[Guide to API Authentication](/whm/tokens/)\ndocumentation.","operationId":"create_user_session","parameters":[{"required":"true","in":"query","name":"user","schema":{"example":"user@example.com","type":"string"},"description":"The session's cPanel account username or a valid email address."},{"required":"true","in":"query","name":"service","schema":{"type":"string","example":"cpaneld","enum":["cpaneld","whostmgrd","webmaild"]},"description":"The session's service."},{"in":"query","name":"cp_security_token","required":"false","description":"The session's security token.","schema":{"type":"string","example":"cpsess1234567890"}},{"description":"The session's locale. This parameter defaults to the *Server Locale* setting in WHM's\n[*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/#system)\ninterface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Note:**\n\n* If you specify a locale, the server sends a cookie to your browser with\nthat locale setting. The cookie expires after one year.\n* Users can change the locale with the language options at the bottom of\nthe login interface.","schema":{"example":"fr","type":"string"},"name":"locale","in":"query","required":"false"},{"required":"false","name":"app","in":"query","schema":{"type":"string","enum":["Backups_Home","Calendar_Configure","ContactInfo_Change","Cron_Home","Database_MySQL","Database_phpMyAdmin","Domains_AddonDomains","Domains_SubDomains","Email_AccountLevelFiltering","Email_Accounts","Email_Archive","Email_Authentication","Email_AutoResponders","Email_BoxTrapper","Email_DefaultAddress","Email_DeliveryReport","Email_Forwarders","Email_GreyListing","Email_MailingLists","Email_MX","Email_SpamFilter","Email_UserLevelFiltering","FileManager_Home","Locale_Change","Password_Change","Site_Software","Site_Software_*","Stats_AWStats","WHMCS_billing","add_a_dns_zone","add_an_a_entry_for_your_hostname","add_a_new_ip_address","add_a_package","additional_mysql_access_hosts","add_remove_recognized_ip_addresses","apache_configuration","apache_mod_userdir_tweak","apache_status","api_shell","api_tokens","apps_managed_by_appconfig","assign_ipv6_address","background_process_killer","backup_configuration","backup_restoration","backup_system_migration","backup_user_selection","basic_webhost_manager_setup","blocker","change_account_contact_email","change_hostname","change_log","change_multiple_sites_ip_addresses","change_mysql_user_password","change_ownership_of_an_account","change_ownership_of_multiple_accounts","change_root_password","change_sites_ip_address","cloudlinux_lve_manager","compiler_access","configuration_cluster","configure_application_locales","configure_cpanel_analytics","configure_cpanel_cron_jobs","configure_postgresql","configure_remote_service_ips","configure_security_policies","contact_manager","convert_addon_domain_to_account","copy_a_locale","copy_an_account_from_another_server_with_an_account_password","cpanel_development_forum","cpanel_log_rotation_configuration","cpanel_plugin_file_generator","cpanel_web_disk_configuration","cpanel_web_services_configuration","cphulk_brute_force_protection","create_a_new_account","create_support_ticket","customization","daily_process_log","database_map_tool","delete_a_dns_zone","delete_a_locale","delete_a_package","directoryindex_priority","dns_cluster","dns_server","easyapache_4","edit_a_locale","edit_a_package","edit_backup_mx_hosts","edit_blacklisted_smtp_ips","edit_dns_zone","edit_mx_entry","edit_only_verify_recipient_smtp_hosts","edit_questions_and_answers","edit_reseller_name_servers_and_privileges","edit_sender_verification_bypass_ips","edit_system_mail_preferences","edit_trusted_smtp_ips","edit_zone_templates","email_all_resellers","email_all_users","email_deliverability","enable_dkim_and_spf_globally","exim_configuration_manager","feature_manager","file_and_directory_restoration","forceful_server_reboot","force_password_change","ftp_server_configuration","ftp_server_proftpd_pureftpd","ftp_server_selection","generate_an_ssl_certificate_and_signing_request","global_configuration","graceful_server_reboot","grant_cpanel_support_access","greylisting","host_access_control","http_server_apache","ico-security-advisor","imap_server","include_editor","initial_quota_setup","install_an_rpm","install_an_ssl_certificate_on_a_domain","install_a_perl_module","install_a_perl_module_process","install_cpaddons_site_software","ip_migration_wizard","ipv6_ranges","legacy_backup_configuration","legacy_language_file_upload","legacy_restore_backups","legacy_restore_multiple_backups","legacy_restore_multiple_backups_confirmation","limit_bandwidth_usage","list_accounts","list_parked_domains","list_subdomains","list_suspended_accounts","locale_editor","locale_xml_download","locale_xml_upload","log_rotation","mailbox_conversion","mail_delivery_reports","mailing_list_manager_mailman","mail_queue_manager","mailserver_configuration","mail_server_exim","mail_troubleshooter","manage_account_suspension","manage_autossl","manage_compiler_group","manage_cpaddons_site_software","manage_custom_rbls","manage_databases","manage_database_users","manage_demo_mode","manage_external_authentication","manage_external_authentication_providers","manage_external_authentication_users","manage_hooks","manage_mysql_profiles","manage_plugins","manage_resellers_ip_delegation","manage_resellers_shared_ip","manage_roots_ssh_keys","manage_services_ssl_certificates","manage_shell_access","manage_ssl_hosts","manage_wheel_group_users","market_provider_manager","memory_usage_restrictions","modify_an_account","modify_cpanel_whm_news","modify_upgrade_multiple_accounts","modsecurity_configuration","modsecurity_tools","modsecurity_vendors","module_installers","multiphp_ini_editor","multiphp_manager","mysql_mariadb_upgrade","mysql_root_password","nameserver_record_report","nameserver_selection","non_standard_locale_configuration","park_a_domain","password_modification","password_strength_configuration","perform_a_dns_cleanup","php_fpm_service_for_apache","phpMyAdmin","piped_log_configuration","process_manager","purchase_and_install_an_ssl_certificate","quota_modification","raw_apache_log_download","raw_ftp_log_download","rearrange_an_account","rebuild_rpm_database","rebuild_the_ip_address_pool","remote_access_key","repair_a_mysql_database","repair_mailbox_permissions","reseller_center","reserved_ips_editor","reset_account_bandwidth_limit","reset_a_dns_zone","reset_a_mailman_password","reset_resellers","resolver_configuration","restore_a_full_backup_cpmove_file","restore_modules_summary","review_transfers_and_restores","security_questions","server_information","server_profile","server_time","service_manager","service_status","setup_edit_domain_forwarding","set_zone_time_to_live_ttl","shell_fork_bomb_protection","show_accounts_over_quota","show_current_disk_usage","show_current_running_processes","show_edit_reserved_ips","show_ip_address_usage","show_mysql_processes","show_or_delete_current_ip_addresses","show_reseller_accounts","skeleton_directory","smtp_restrictions","software_development_kit","spamd_startup_configuration","sql_server_mysql","sql_server_pgsql","ssh_password_authorization_tweak","ssh_server_openssh","ssl_storage_manager","statistics_software_configuration","support_center","synchronize_dns_records","system_update","task_queue_monitor","terminal","terminate_accounts","theme_manager","traceroute_enable_disable","transfer_tool","tweak_settings","two_factor_authentication","unsuspend_bandwidth_exceeders","update_database_map","update_database_map_process","update_preferences","update_server_software","upgrade_downgrade_an_account","upgrade_to_latest_version","view_available_locales","view_bandwidth_usage","view_mail_statistics_summary","view_relayers","view_reseller_usage_and_manage_account_status","view_sent_summary","web_template_editor"],"example":"Backups_Home"},"description":"The cPanel or WHM application to which the session will link. This\nparameter defaults to a blank string, which redirects the user to the\ncPanel\n[*Home*](https://docs.cpanel.net/cpanel/the-cpanel-interface/the-cpanel-interface/)\ninterface.\n\n* A valid application name, to link the session to an application.\n* An invalid application name, to create the session but **not** link\nit to an application."},{"name":"preferred_domain","in":"query","required":"false","description":"The hostname or IP address for the function to use in the `url`\nreturn. This parameter's value defaults to the server's hostname.","schema":{"example":"example.com","type":"string"}},{"name":"promptToken","in":"query","required":"false","description":"The prompt token to pre-populate the user's website-generation goals\nwhen logging into the Nova interface.\n\n**Note:**\n\n* This value must be base64-encoded.\n* Maximum decoded length is 5000 characters.","schema":{"example":"SSB3YW50IHRvIGNyZWF0ZSBhIHJlc3RhdXJhbnQgd2Vic2l0ZQ==","type":"string"}}],"x-cpanel-available-version":"11.40","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"create_user_session","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"example":"Created session","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"url":{"example":"https://example.com:2083/cpsess1234567890/login/?session=username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa&locale=fr","description":"The security token's URL. The URL contains the values of\nthe `preferred_domain`, `session`, and `app` parameters.","type":"string"},"expires":{"type":"integer","example":"1401993893","format":"unix_timestamp","description":"When the security token expires, in Unix time format."},"cp_security_token":{"type":"string","example":"/cpsess1234567890","description":"The session's security token."},"session":{"example":"username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa","description":"The session ID.\n\n**Note:**\n\nIf the `app` parameter contains a valid application, the URL **also**\ncontains the application information.","type":"string"},"service":{"description":"The security token's service.","example":"cpaneld","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Session"],"name":"API Development Tools"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"API Development Tools / Session","name":"Session"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"removeacct":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"88","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"tags":[{"description":"Accounts / Account Management","name":"Account Management"}],"servers":[{"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."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"paths":{"/removeacct":{"get":{"tags":["Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  removeacct \\\n  username='username'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/removeacct?api.version=1&username=username"}],"x-cpanel-api-version":"WHM API 1","summary":"Delete cPanel account","parameters":[{"description":"The account's username.","schema":{"type":"string","example":"username"},"in":"query","name":"username","required":"true"},{"schema":{"type":"string","example":"username"},"deprecated":"true","description":"The account's username.","in":"query","name":"user"},{"schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"description":"Whether to retain the account's DNS entries.\n- `1` — Retain DNS entries.\n- `0` — Delete DNS entries.","required":"false","name":"keepdns","in":"query"}],"operationId":"removeacct","description":"This function deletes a cPanel or WHM account.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The 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"},"output":{"type":"object","properties":{"raw":{"type":"string","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\""}}},"result":{"description":"- `1` — Success\n- `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"description":"The method name called.","example":"removeacct","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11"}}}},"convert_addon_fetch_domain_details":{"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"paths":{"/convert_addon_fetch_domain_details":{"get":{"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"example":"1","description":"The API version of the function.","type":"integer"},"command":{"example":"convert_addon_fetch_domain_details","type":"string"},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","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":"object"},"data":{"type":"object","properties":{"is_sni_supported":{"type":"integer","description":"Whether the domain supports Server Name Indication (SNI).\n\n* `1` — The domain supports SNI.\n* `0` — The domain does **not** support SNI.","example":"0","enum":["1","0"]},"number_of_domain_forwarders":{"minimum":"0","type":"integer","example":"1","description":"The number of the domain's domain forwarders."},"ip":{"type":"string","example":"192.0.2.0","description":"The domain's IP address.","format":"ipv4"},"docroot":{"description":"The absolute file path of the addon domain.","example":"/home/exampleparent/public_html/example.com","type":"string"},"has_ssl_cert_installed":{"type":"integer","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.","example":"0","enum":["1","0"]},"number_of_email_accounts":{"example":"2","description":"The number of the domain's email accounts.","minimum":"0","type":"integer"},"has_dedicated_ip":{"type":"integer","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.","example":"0","enum":["1","0"]},"owner":{"description":"The addon domain owner's cPanel account username.","format":"username","example":"username","type":"string"},"number_of_email_forwarders":{"description":"The number of the domain's email forwarders.","example":"1","type":"integer","minimum":"0"},"number_of_autoresponders":{"type":"integer","minimum":"0","example":"0","description":"The number of the domain's autoresponders."}}}}}}}}},"operationId":"convert_addon_fetch_domain_details","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.","parameters":[{"schema":{"type":"string","example":"example.com","format":"domain"},"description":"The addon domain for which to retrieve details.","required":"true","in":"query","name":"domain"}],"summary":"Return additional domain data","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  convert_addon_fetch_domain_details \\\n  domain='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_fetch_domain_details?api.version=1&domain=example.com","lang":"HTTP","label":"URL"}],"tags":["Domain Information"]}}},"tags":[{"description":"Accounts / Domain Domain Information","name":"Domain Information"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"killdns":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"paths":{"/killdns":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"command":{"example":"killdns","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"Zones Removed","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"output":{"properties":{"raw":{"description":"The raw response output.","example":"example.com => deleted from example.","type":"string"}},"type":"object"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"name":"domain","in":"query","required":"true","description":"The zone record's domain.","schema":{"format":"domain","example":"example.com","type":"string"}}],"operationId":"killdns","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.\n\n**NOTE:**\n\nYou **cannot** use this function to delete temporary domains.","summary":"Delete DNS zone","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  killdns \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/killdns?api.version=1&domain=example.com"}],"tags":["DNS","DNS Zones"]}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Zones","name":"DNS Zones"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"get_available_profiles":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Profiles","name":"Server Profiles"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Server Administration","tags":["Server Profiles"]}],"paths":{"/get_available_profiles":{"get":{"summary":"Return available server profiles","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_available_profiles\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_profiles?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Server Administration","Server Profiles"],"x-cpanel-available-version":"76","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"get_available_profiles","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["1","0"],"type":"integer"}}},"data":{"type":"object","properties":{"profiles":{"type":"array","example":[{"code":"STANDARD","experimental":"0","description":"The Standard Node profile provides all services and access to every cPanel feature.","enabled_roles":[{"module":"CalendarContact","description":"Calendars and Contacts provides CalDAV and CardDAV services.","name":"Calendars and Contacts"},{"name":"DNS","description":"DNS allows users to create and edit Domain Name System zone files.","module":"DNS"},{"description":"FTP allows users to manage the files associated with their site with an FTP client.","module":"FTP","name":"FTP"},{"name":"File Storage","module":"FileStorage","description":"File Storage allows users to access the File Manager and Git™ Version Control features."},{"module":"MailReceive","description":"Receive Mail allows users to receive email, as well as create and manage their email accounts.","name":"Receive Mail"},{"name":"Send Mail","description":"Send Mail allows users to send email.","module":"MailSend"},{"name":"Local Mail","module":"MailLocal","description":"Local Mail allows the system to process email."},{"description":"MySQL®/MariaDB allows users to create and manage MySQL/MariaDB databases.","module":"MySQL","name":"MySQL/MariaDB"},{"name":"PostgreSQL","description":"PostgreSQL allows users to create and manage PostgreSQL databases.","module":"Postgres"},{"name":"Spam Filter","description":"Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.","module":"SpamFilter"},{"description":"Webmail provides access to webmail services.","module":"Webmail","name":"Webmail"},{"name":"Web Disk","description":"Web Disk allows users to manage and manipulate files on the server with multiple types of devices.","module":"WebDisk"},{"description":"Web Server allows users to create and manage websites for their domains.","module":"WebServer","name":"Web Server"}]}],"description":"An array of objects that contains the available server profiles.","items":{"properties":{"enabled_roles":{"type":"array","items":{"type":"object","properties":{"name":{"example":"Receive Mail","description":"The role's name.","type":"string"},"module":{"type":"string","example":"MailReceive","description":"The role's module name."},"description":{"type":"string","description":"The role's description.","example":"Receive Mail allows users to receive email, as well as create and manage their email accounts."}}},"description":"The roles that this profile enables."},"description":{"example":"This profile provides only services and cPanel features that allow the system to serve mail.","description":"The profile's description.","type":"string"},"name":{"description":"The profile's name.","example":"Mail","type":"string"},"code":{"description":"The profile's ID.","example":"MAILNODE","type":"string"},"disabled_roles":{"items":{"properties":{"name":{"example":"File Storage","description":"The role's name.","type":"string"},"description":{"example":"File Storage allows users to access the File Manager and Git™ Version Control features.","description":"The role's description.","type":"string"},"module":{"description":"The role's module name.","example":"FileStorage","type":"string"}},"type":"object"},"description":"The roles that this profile disables. The function returns an empty array if no disabled roles exist.","type":"array"},"optional_roles":{"type":"array","items":{"properties":{"module":{"type":"string","example":"DNS","description":"The role's module name."},"description":{"description":"The role's description.","example":"DNS allows users to create and edit Domain Name System zone files.","type":"string"},"name":{"type":"string","example":"DNS","description":"The role's name."}},"type":"object"},"description":"The optional roles that this profile enables. The function returns an empty array if no optional roles exist."},"experimental":{"type":"integer","example":"0","enum":["1","0"],"description":"Whether the profile is experimental.\n* `1` - Experimental.\n* `0` - **Not** experimental."}},"type":"object"}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"get_available_profiles","description":"This function returns a list of available server profiles.","parameters":[]}}}},"get_domain_info":{"paths":{"/get_domain_info":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return all domains information","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_domain_info\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_domain_info?api.version=1"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"items":{"properties":{"ipv6":{"type":"string","nullable":"true","description":"The domain's IPv6 address.\n* A valid IPv6 address.\n* `null` An IPv6 address does not exist for this domain.","example":"2001:DB8:g1m:0N3y::1"},"modsecurity_enabled":{"description":"Whether ModSecurity is enabled on the server.\n* `1` ModSecurity is enabled.\n* `0` ModSecurity is not enabled.","enum":["0","1"],"example":"1","type":"integer"},"parent_domain":{"description":"The parent domain. A valid domain name.","example":"example.com","type":"string"},"user_owner":{"type":"string","example":"user1","description":"The domain's owner."},"docroot":{"example":"/home/user1/public_html/example.com","description":"The document root for the addon domain. An absolute file path.","type":"string"},"ipv6_is_dedicated":{"example":"1","enum":["0","1"],"description":"The domain possesses an IPv6 address.\n* `1` An IPv6 address exists for this domain.\n* `0` An IPv6 address does not exist for this domain.","type":"integer"},"domain_type":{"example":"addon","description":"The domain's type.","type":"string"},"domain":{"type":"string","description":"The account's main domain. A valid domain.","example":"example.com"},"ipv4_ssl":{"description":"The domain's secure IPv4 address. A valid IPv4 address.","example":"192.0.2.255","type":"string"},"ipv4":{"description":"The domain's IPv4 address. A valid IPv4 address.","example":"192.0.2.255","type":"string"},"port":{"type":"integer","description":"The server's port number.","example":"80"},"php_version":{"description":"The installed PHP versions.","example":"ea-php54","type":"string"},"user":{"example":"username","description":"The account username. A cPanel account or reseller username on the server.","type":"string"},"port_ssl":{"description":"The server's secure port number.","example":"443","type":"integer"}},"type":"object"},"description":"array of objects representing the domain's data.\n\n**Note:**\n\n This return only includes domains that you manually created. This does not include service subdomain (proxy subdomains) or automatically-created domains.","type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` Success\n* `0` Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","example":"get_domain_info","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"70","parameters":[],"description":"This function returns information about each domain on the server.","operationId":"get_domain_info"}}},"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Accounts / Domain Information","name":"Domain Information"}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"configureservice":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Services","description":"Server Administration / Services"}],"paths":{"/configureservice":{"get":{"description":"This function enables or disables a service and its monitoring.\n\n**Note:**\n\nIf the user only possesses the `clustering`\n[Access Control List (ACL)](https://go.cpanel.net/ACLReferenceChart),\nthen this function can only act on the `named` service.","operationId":"configureservice","parameters":[{"name":"service","in":"query","required":"true","description":"The service to configure. For more information about each service, read our\n[*Service Manager*](https://go.cpanel.net/whmdocsServiceManager)\ndocumentation.","schema":{"example":"mysql","enum":["apache_php_fpm","cpanel-dovecot-solr","cpanel_php_fpm","cpanellogd","cpdavd","cphulkd","cpsrvd","crond","dnsadmin","exim","exim-altport","ftpd","httpd","imap","ipaliases","lmtp","mailman","mysql","named","nscd","p0f","pop","postgresql","queueprocd","rsyslogd","spamd","sshd"],"type":"string"}},{"description":"Whether to enable the service.\n\n* `1` — Enable.\n* `0` — Disable.\n\nIf you do not use this parameter, the function will **not** change\nthe enabled status of the service.\n\n**Warning:**\n\nDo **not** use this function to disable the `cpsrvd` service.","schema":{"type":"integer","enum":["0","1"],"example":"1"},"name":"enabled","in":"query","required":"false"},{"in":"query","name":"monitored","required":"false","description":"Whether to monitor the service in WHM's\n[*Service Status*](https://docs.cpanel.net/whm/server-status/service-status/)\ninterface (*WHM >> Home >> Server Status >> Service Status*).\n\n* `1` — Monitor.\n* `0` — Do **not** monitor.\n\nIf you do not use this parameter, the function will **not** change the\nmonitoring status of the service.","schema":{"type":"integer","enum":["0","1"],"example":"1"}},{"schema":{"type":"string","example":"26, 5000, 6000","default":"26"},"description":"A port or list of comma-separated ports on which Exim will listen for\ninbound connections.\n\n**Note:**\n\nThe function **only** uses this parameter if you set `exim-altport` as\nthe `service` parameter's value.","required":"false","name":"exim-altportnum","in":"query"}],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"Enabled monitoring for mysql.","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"configureservice","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}}}}}}},"tags":["Server Administration","Services"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  configureservice \\\n  service='mysql'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/configureservice?api.version=1&service=mysql"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable or disable a service and its monitoring"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Services"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"list_databases":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"description":"Databases / MySQL Databases","name":"MySQL Databases"}],"paths":{"/list_databases":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"payload":{"description":"An array of objects that contain of database data.","items":{"properties":{"engine":{"type":"string","enum":["mysql","postgresql"],"example":"postgresql","description":"The database's engine.\n- `mysql`\n- `postgresql`"},"cpuser":{"example":"example","format":"username","description":"The database's owner.","type":"string"},"name":{"description":"The database's name.","example":"example_db0","type":"string"}},"type":"object"},"type":"array"}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"list_databases","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[],"operationId":"list_databases","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.","summary":"Return MySQL databases","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_databases\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_databases?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Databases","MySQL Databases"]}}},"x-tagGroups":[{"tags":["MySQL Databases"],"name":"Databases"}],"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"authorizesshkey":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"tags":[{"description":"Authentication / SSH Keys and Connections","name":"SSH Keys and Connections"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"name":"Authentication","tags":["SSH Keys and Connections"]}],"paths":{"/authorizesshkey":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"command":{"example":"authorizesshkey","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"file":{"type":"string","description":"The public SSH key file's name.","example":"sshkey.pub"},"authorized":{"type":"integer","description":"Whether the public SSH key has authorization.\n* `1` — Authorized.\n* `0` — **Not** authorized.","enum":["1","0"],"example":"1"}}}}}}}}},"x-cpanel-available-version":"11","parameters":[{"schema":{"example":"sshkey.pub","type":"string"},"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.","required":"true","in":"query","name":"file"},{"required":"true","name":"text","in":"query","schema":{"type":"string","example":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCys7JbGhkAZ8E4Pmq8D4EBm1UedKK2oMhs3RVIEFRJX6S86Itw6Qmhds62LNGrxuVL11W6v25+maIiBhXnslyQpd838tHyAC7J/SJojDid8acovX/4xgJQaJHLAh9tLgyQXnNhIxIGJ4nVZ+8OqM2Vb1Cps+E5H17ivG07PXnVPEvwMaeWkm2DnGgSy5kmjVpNKlj9GWFCn/SJd7up7QnbGKoz87pxKDs3esp+ziuPEAJHLeXnKHWPVukQgtRUpUBdqkCvu5hUkhpaiWmBR8yxajkxbSObPw+ZkELhmm+fQseOfEbrwToMRJCO7gAKwBtNi7OhyFM7YFrvdo0xh6cn"},"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."},{"required":"true","name":"authorize","in":"query","schema":{"enum":["1","0"],"example":"1","type":"integer"},"description":"Whether to authorize the public SSH key to access the server.\n\n* `1` — Authorize.\n* `0` — Do **not** authorize."},{"in":"query","name":"options","required":"false","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.","schema":{"example":"agent-forwarding,cert-authority","type":"string"}}],"operationId":"authorizesshkey","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.","summary":"Enable SSH key for server","x-cpanel-api-version":"WHM API 1","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"}],"tags":["SSH Keys and Connections"]}}}},"unset_manual_mx_redirects":{"paths":{"/unset_manual_mx_redirects":{"get":{"x-cpanel-available-version":"90","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"unset_manual_mx_redirects","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"payload":{"example":{"example.com":"mailhostexample.com","example.org":null},"description":"The removed manual MX redirect entry for each domain.","type":"object","additionalProperties":{"nullable":"true","description":"The domain’s former MX redirect target, or null if the domain did not have an MX redirect target.","example":"mailhostexample.com","type":"string","x-additionalPropertiesName":"domain"}}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"description":"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.\n\n**Note:**\n\n  To set a domain's manual MX redirection, use the WHM API 1  set_manual_mx_redirects function.","operationId":"unset_manual_mx_redirects","parameters":[{"in":"query","name":"domain","required":"true","description":"The domain for which to remove a manual MX redirect entry.\n\n**Note:**\n\n To remove multiple domain entries, increment the parameter. For example, use the domain, domain-1, and domain-2 parameters.","schema":{"example":"example.com","type":"string"}}],"x-cpanel-api-version":"WHM API 1","summary":"Remove manual mail exchanger redirect record","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  unset_manual_mx_redirects \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unset_manual_mx_redirects?api.version=1&domain=example.com"}]}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.91.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"listmxs":{"paths":{"/listmxs":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"record":{"description":"An array of zone record data objects.","items":{"properties":{"name":{"example":"hostname.example.com","description":"The record's name.","type":"string"},"ttl":{"example":"86400","description":"The record's Time To Live (TTL) in seconds.","type":"integer","minimum":"1"},"Line":{"example":"1","description":"The zone record's line number.","minimum":"1","type":"integer"},"exchange":{"example":"mail.example.com","format":"domain","description":"The domain's mail exchanger.","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"},"type":{"type":"string","example":"MX","description":"The DNS record's type."},"class":{"type":"string","example":"IN","description":"The record's class."}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The 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"},"command":{"example":"listmxs","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","format":"domain","example":"example.com"},"description":"The zone record's domain."}],"operationId":"listmxs","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.","x-cpanel-api-version":"WHM API 1","summary":"Return domain's mail exchanger records","tags":["DNS","Domain Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  listmxs \\\n  domain='example.com'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/listmxs?api.version=1&domain=example.com"}]}}},"x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"Domain Management","description":"DNS / Domain Management"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"cpgreylist_load_common_mail_providers_config":{"tags":[{"name":"Greylisting","description":"The Greylisting module for WHM API 1."},{"description":"Mail / Spam Protection (Greylisting)","name":"Spam Protection (Greylisting)"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"paths":{"/cpgreylist_load_common_mail_providers_config":{"get":{"parameters":[],"operationId":"cpgreylist_load_common_mail_providers_config","description":"This function returns Greylisting's list of common mail service providers.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"cpgreylist_load_common_mail_providers_config","description":"The method name called.","type":"string"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"autotrust_new_common_mail_providers":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether Greylisting automatically trusts new mail providers that WebPros International, LLC adds to the common mail providers list.\n* `1` - New mail providers are automatically trusted.\n* `0` - New mail providers are **not** automatically trusted."},"common_mail_providers":{"type":"object","additionalProperties":{"type":"object","properties":{"autoupdate":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether Greylisting automatically trusts new IP addresses that WebPros International, LLC adds for this mail provider.\n* `1` - New IP addresses are automatically trusted.\n* `0` - New IP addresses are **not** automatically trusted."},"display_name":{"description":"The mail provider's name.","example":"cPanel","type":"string"},"is_trusted":{"description":"Whether Greylisting trusts this mail provider's IP addresses.\n* `1` - The provider is trusted.\n* `0` - The provider is **not** trusted.","example":"1","enum":["0","1"],"type":"integer"}},"description":"An object containing the provider's data.\n\n**Note:**\n\n  The object's name is the provider's key name."},"example":{"sectigo":{"autoupdate":"1","is_trusted":"1","display_name":"Comodo/Sectigo"},"cpanel":{"is_trusted":"1","display_name":"cPanel","autoupdate":"1"}},"description":"An object containing common mail provider settings."}}}}}}}}},"x-cpanel-available-version":"11.52","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_load_common_mail_providers_config\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_load_common_mail_providers_config?api.version=1"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"summary":"Return Greylisting mail providers","x-cpanel-api-version":"WHM API 1"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}}},"ticket_validate_oauth2_code":{"paths":{"/ticket_validate_oauth2_code":{"get":{"operationId":"ticket_validate_oauth2_code","description":"This function validates the OAuth2 code from the\n[cPanel Customer Portal](https://tickets.cpanel.net/).\nAfter the function validates the token, the system stores it on the current session.\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call it\nas a request body.","parameters":[{"required":"true","in":"query","name":"code","schema":{"example":"84b1a729-63e3-11e6-a0fb-bfcf357fd76d","type":"string"},"description":"The code from the OAuth2 redirect. The system validates this code and exchanges it for a token."},{"schema":{"type":"string","example":"https://hostname.example.com:2087/"},"description":"The redirect URI query argument that the system sent to the initial OAuth2 authentication endpoint.","required":"true","name":"redirect_uri","in":"query"}],"x-cpanel-available-version":"60","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"ticket_validate_oauth2_code","description":"The method name called.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"tags":["Support Tickets","Ticket Management"],"x-codeSamples":[{"source":"https://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","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"false","summary":"Validate Customer Portal OAuth2 code"}}},"x-tagGroups":[{"name":"cPanel Support Tickets","tags":["Ticket Management"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Support Tickets","description":"The Support Tickets module for WHM API 1."},{"description":"cPanel Support Tickets / Ticket Management","name":"Ticket Management"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"remove_autossl_user_excluded_domains":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"paths":{"/remove_autossl_user_excluded_domains":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remove_autossl_user_excluded_domains \\\n  username='username' \\\n  domain='cpcalendars.example.com'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_autossl_user_excluded_domains?api.version=1&username=username&domain=cpcalendars.example.com"}],"tags":["SSL","Auto-Generated Certificates"],"summary":"Remove AutoSSL for domain","x-cpanel-api-version":"WHM API 1","parameters":[{"schema":{"example":"username","format":"username","type":"string"},"description":"The cPanel user's account.","required":"true","name":"username","in":"query"},{"required":"true","in":"query","name":"domain","schema":{"type":"string","example":"cpcalendars.example.com","format":"domain"},"description":"Enable AutoSSL for this domain.\n\n**Note:**\n\nFor multiple domains, increment the parameter name. For example, domain-1, domain-2, and domain-3.","examples":{"single":{"summary":"Enable AutoSSL for a single domain.","value":"cpcalendars.example.com"},"multiple":{"value":"domain-1=cpcalendars.example.com&domain-2=cpcontacts.example.com","summary":"Enable AutoSSL for multiple domains."}}}],"description":"This function enables AutoSSL for an account's specified domains.","operationId":"remove_autossl_user_excluded_domains","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","example":"remove_autossl_user_excluded_domains","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"66"}}},"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"nvget":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Styles","description":"The Server Administration module for WHM API 1."}],"paths":{"/nvget":{"get":{"x-cpanel-available-version":"11","description":"This function retrieves the value of a non-volatile variable. 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.\n\n**Note:**\n\nThis function is **deprecated**. We recommend that you use the `personalization_get` function.","operationId":"nvget","parameters":[{"description":"The variable's name.","schema":{"example":"ThermalDetonator","type":"string"},"name":"key","in":"query","required":"true"}],"x-cpanel-api-version":"WHM API 1","summary":"Return non-volatile variable value","tags":["Styles"],"deprecated":"true","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"nvdatum":{"properties":{"value":{"items":{"type":"string","example":"Active"},"description":"The variable's value.","type":"array"},"key":{"description":"The variable's name.","example":"ThermalDetonator","type":"string"}},"type":"object","description":"An object that contains the variable's information."}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","description":"The method name called.","example":"nvget"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-internal-only":"true","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  nvget \\\n  key='ThermalDetonator'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/nvget?api.version=1&key=ThermalDetonator"}]}}},"x-tagGroups":[{"name":"Accounts","tags":["Styles"]}],"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"restore_queue_add_task":{"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Account"]}],"paths":{"/restore_queue_add_task":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_add_task \\\n  user='username' \\\n  restore_point='2019-10-21T00:00:00.000Z'\n","label":"CLI","lang":"Shell"},{"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"}],"tags":["Account Restoration","Restore Account"],"summary":"Restore user account from backup","x-cpanel-api-version":"WHM API 1","description":"This function restores a user's cPanel account from a backup file.","operationId":"restore_queue_add_task","parameters":[{"required":"true","in":"query","name":"user","schema":{"type":"string","example":"username"},"description":"The cPanel account's username."},{"description":"The date of the backup to use, in `YYYY-MM-DD` format.","schema":{"type":"string","example":"2019-10-21T00:00:00.000Z"},"name":"restore_point","in":"query","required":"true"},{"in":"query","name":"give_ip","required":"false","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.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]}},{"name":"mysql","in":"query","required":"false","description":"Whether to restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"}},{"description":"Whether to restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"name":"subdomains","in":"query","required":"false"},{"schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"description":"Whether to restore the account's email configuration.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","required":"false","in":"query","name":"mail_config"},{"schema":{"default":"local","example":"LmTZCUpqqLSPH8AO7pVtIeNK","type":"string"},"description":"The destination's identification string.\n\n* `local` — The local directory.\n* The destination ID string's value.","required":"false","in":"query","name":"destid"}],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","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":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"example":"restore_queue_add_task","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}}}}},"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"name":"Restore Account","description":"Account Restoration / Restore Account"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"restore_queue_clear_all_completed_tasks":{"paths":{"/restore_queue_clear_all_completed_tasks":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Remove all completed restoration tasks","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_clear_all_completed_tasks\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_completed_tasks?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"restore_queue_clear_all_completed_tasks"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function removes successfully completed tasks from the restoration queue.","operationId":"restore_queue_clear_all_completed_tasks","parameters":[]}}},"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"description":"Account Restoration / Restore Queue Management","name":"Restore Queue Management"}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"cphulk_status":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Management","name":"Management"}],"paths":{"/cphulk_status":{"get":{"tags":["cPHulk","Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cphulk_status\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cphulk_status?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return login security status","operationId":"cphulk_status","description":"This function returns the status of the cPHulk service.","parameters":[],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"service":{"type":"string","example":"cPHulk","description":"The cPHulk service's name."},"is_enabled":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether the cPHulk service is enabled.\n* `1` - cPHulk is enabled.\n* `0` - cPHulk is disabled."}},"type":"object"},"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"cphulk_status","type":"string"},"reason":{"type":"string","example":"OK","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."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Management"]}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_available_tiers":{"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"paths":{"/get_available_tiers":{"get":{"tags":["Updates"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_available_tiers\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_tiers?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel & WHM available versions","description":"This function lists of each available version of cPanel & WHM, and each\nversion's latest maintenance release. This function also lists the cPanel & WHM\nversion for each\n[release tier](https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/).","operationId":"get_available_tiers","parameters":[],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"lts":{"description":"The version of cPanel & WHM that is currently on the LTS tier.","type":"string"},"current":{"description":"The version of cPanel & WHM that is currently on the CURRENT tier.","type":"string"},"release":{"type":"string","description":"The version of cPanel & WHM that is currently on the RELEASE tier."},"edge":{"description":"The version of cPanel & WHM that is currently on the EDGE tier.","type":"string"},"stable":{"type":"string","description":"The version of cPanel & WHM that is currently on the STABLE tier."}},"additionalProperties":{"description":"The latest maintenance release for a cPanel & WHM version number.","type":"string"},"type":"object","description":"A list of the latest available version of cPanel & WHM.","example":{"11.64":"11.64.0.42","lts":"11.86.0.24","11.68":"11.68.0.39","11.72":"11.72.0.12","11.82":"11.82.0.19","11.50":"11.50.6.2","11.88":"11.88.0.13","11.74":"11.74.0.12","11.78":"11.78.0.49","11.84":"11.84.0.22","11.62":"11.62.0.48","11.36":"11.36.2.12","11.30":"11.30.8.0","11.44":"11.44.3.5","11.48":"11.48.5.3","11.42":"11.42.1.31","11.56":"11.56.0.52","release":"11.88.0.13","11.32":"11.32.7.3","11.66":"11.66.0.35","11.76":"11.76.0.22","11.40":"11.40.1.22","11.86":"11.86.0.24","11.34":"11.34.2.8","11.38":"11.38.2.23","edge":"11.90.0.3","11.46":"11.46.4.0","11.70":"11.70.0.69","11.52":"11.52.6.6","11.80":"11.80.0.24","11.58":"11.58.0.52","11.90":"11.90.0.3","11.54":"11.54.0.36","current":"11.90.0.3","11.60":"11.60.0.48","stable":"11.88.0.13"}},"metadata":{"properties":{"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"get_available_tiers","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Got tiers list","type":"string"}}}}}}}}}}}},"x-tagGroups":[{"name":"Server Administration","tags":["Updates"]}]},"set_up_dns_resolver_workarounds":{"paths":{"/set_up_dns_resolver_workarounds":{"get":{"operationId":"set_up_dns_resolver_workarounds","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.","parameters":[],"x-cpanel-available-version":"84","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"set_up_dns_resolver_workarounds","description":"The method name called."}}},"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":{"type":"string","description":"The system **cannot** create an [IPv6](https://en.wikipedia.org/wiki/IPv6) socket.","example":"no"},"edns-buffer-size":{"type":"string","example":"512","description":"The [extension mechanism for DNS (EDNS)](https://en.wikipedia.org/wiki/Extension_mechanisms_for_DNS) length size is at or exceeds 512 bytes."},"do-udp":{"type":"string","description":"The system **cannot** receive a [User Datagram Protocol (UDP)](https://en.wikipedia.org/wiki/User_Datagram_Protocol) DNS response.","example":"no"}},"type":"object"}},"type":"object"}}}}}}},"tags":["DNS","Resolvers"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_up_dns_resolver_workarounds\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_up_dns_resolver_workarounds?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Create unbound DNS resolver"}}},"x-tagGroups":[{"tags":["Resolvers"],"name":"DNS"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"description":"DNS / Resolvers","name":"Resolvers"}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"api_token_revoke":{"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"API Token Management","description":"API Development Tools / API Token Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"API Development Tools","tags":["API Token Management"]}],"paths":{"/api_token_revoke":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  api_token_revoke \\\n  token_name='subway'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/api_token_revoke?api.version=1&token_name=subway","label":"URL","lang":"HTTP"}],"tags":["Authentication","API Token Management"],"summary":"Disable WHM API token","x-cpanel-api-version":"WHM API 1","operationId":"api_token_revoke","description":"This function revokes an API token from the WHM account.","parameters":[{"required":"true","name":"token_name","in":"query","schema":{"example":"subway","type":"string"},"examples":{"single":{"value":"subway","summary":"Revoke a single API token."},"multiple":{"value":"token_name-1=subway&token_name-2=job&token_name-3=jmkMRXBnhp20iz","summary":"Revoke multiple API tokens."}},"description":"The API token's name.\n\n**Note:**\n\nTo revoke multiple API tokens, increment this parameter's name. For example: `token_name-1`, `token_name-2`, and `token_name-3`."}],"x-cpanel-available-version":"64","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"api_token_revoke"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details."}}}},"type":"object"}}}}}}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"}},"cpgreylist_untrust_entries_for_common_mail_provider":{"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/cpgreylist_untrust_entries_for_common_mail_provider":{"get":{"operationId":"cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider","description":"This function marks the IP addresses for the specified mail provider as not trusted.\nGreylisting defers emails from non-trusted IP addresses.","parameters":[{"in":"query","name":"provider","required":"true","examples":{"single":{"value":"1","summary":"Trust a single mail provider"},"multiple":{"summary":"Trust multiple mail providers","value":"provider-1=10 provider-2=33 provider-3=15"}},"description":"The mail provider.\n\n**Note:**\n\nTo trust multiple mail providers,\n increment the parameter name. For example, provider-0, provider-1, provider-2.","schema":{"type":"string","example":"cpanel"}}],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"providers_failed":{"additionalProperties":{"properties":{"ips_untrusted":{"type":"integer","description":"The mail providers that failed to update.","example":"21"}},"x-additionalPropertiesName":"provider_key","type":"object","description":"The mail provider's data."},"type":"object"},"providers_untrusted":{"additionalProperties":{"example":"Unknown mail provider.","description":"The reason why the change for a provider failed.","x-additionalPropertiesName":"provider_key","type":"string"},"description":"The mail providers that Greylisting does not trust."}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"cpgreylist_untrust_entries_for_common_mail_provider","description":"The method name called."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","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."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_untrust_entries_for_common_mail_provider \\\n  provider='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_untrust_entries_for_common_mail_provider?api.version=1&provider=1"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"summary":"Add mail provider to Greylisting non-trusted hosts","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Protection (Greylisting)"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}]},"verify_new_username_for_restore":{"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"description":"Account Restoration / Restore Account","name":"Restore Account"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Account"]}],"paths":{"/verify_new_username_for_restore":{"get":{"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"verify_new_username_for_restore","description":"The method name called.","type":"string"},"result":{"description":"- `1` — Success.\n- `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"verify_new_username_for_restore","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.","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account that you wish to transfer to the server.","schema":{"example":"username","type":"string"}}],"summary":"Validate username during restoration","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  verify_new_username_for_restore \\\n  user='username'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_new_username_for_restore?api.version=1&user=username"}],"tags":["Account Restoration","Restore Account"]}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}}},"get_featurelists":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"tags":["Feature Lists"],"name":"Hosting Plans"}],"paths":{"/get_featurelists":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return current user's available feature lists","tags":["Packages","Feature Lists"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_featurelists\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_featurelists?api.version=1"}],"x-cpanel-available-version":"11.52","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"get_featurelists","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}},"data":{"properties":{"featurelists":{"description":"An array of available feature lists.","items":{"example":"default","type":"string"},"example":["default","disabled","reseller1_test1","reseller1_test2"],"type":"array"}},"type":"object"}}}}}}},"operationId":"get_featurelists","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.","parameters":[]}}}},"list_blocked_incoming_email_countries":{"paths":{"/list_blocked_incoming_email_countries":{"get":{"x-cpanel-available-version":"84","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"countries":{"description":"An array of objects that contain each blocked country.","items":{"type":"object","properties":{"country_code":{"type":"string","description":"The [ISO-3166-1 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html) of the blocked country.","example":"AD"}}},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"list_blocked_incoming_email_countries","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}}}}},"description":"HTTP Request was successful."}},"description":"This function lists which countries cannot send email to the server.","operationId":"list_blocked_incoming_email_countries","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return blocked email countries list","tags":["Mail","Spam Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_blocked_incoming_email_countries\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_blocked_incoming_email_countries?api.version=1","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Spam Management","description":"Mail / Spam Management"}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"remove_integration_group":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Integration module for WHM API 1.","name":"Integration"},{"description":"Integrations / Links","name":"Links"}],"paths":{"/remove_integration_group":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Remove integration link group","tags":["Integration","Links"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remove_integration_group \\\n  user='username' \\\n  group_id='WHMCS'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_integration_group?api.version=1&user=username&group_id=WHMCS","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"reason":{"example":"Ok","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"remove_integration_group","description":"The method name called."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"remove_integration_group","description":"This removes a group of integration links from the cPanel interface.","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account name.","schema":{"type":"string","example":"username","format":"username"}},{"schema":{"example":"WHMCS","type":"string"},"description":"The group's ID.","required":"true","in":"query","name":"group_id"}]}}},"x-tagGroups":[{"name":"Integrations","tags":["Links"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"save_connected_application":{"x-tagGroups":[{"tags":["Connected Applications"],"name":"Server Administration"}],"paths":{"/save_connected_application":{"post":{"x-codeSamples":[{"source":"echo '{\"data\":{\"jwt\":{\"callback_url\":\"https://application-1.com/api/si/servers/registrations/callback,\",\"challenge\":\"ddd13a92-d55e-4818-a960-9776ede6cd74,\",\"email\":\"john.doe@email.example,\",\"exp\":\"1401912171,\",\"ips\":[\"1.1.1.1\",\"2.2.2.2\"],\"iss\":\"https://application-1.com\",\"iss_desc\":\"Sample application\",\"name\":\"John Doe,\",\"redirect_url\":\"https://application-1/redirect,\",\"scope\":[\"admin:users,\",\"admin:resellers\",\"admin:domains\"],\"state\":\"xyz\"},\"private_key\":\"FEF6253E6A122532430D\",\"public_key\":\"AAF6253E6A1225324305623EE\",\"token_name\":\"Application 1 API Token\"},\"name\":\"application-1\"}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n  save_connected_application","lang":"Shell","label":"CLI"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/save_connected_application HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 599\n\n{\"api.version\":\"1\",\"data\":{\"jwt\":{\"callback_url\":\"https://application-1.com/api/si/servers/registrations/callback,\",\"challenge\":\"ddd13a92-d55e-4818-a960-9776ede6cd74,\",\"email\":\"john.doe@email.example,\",\"exp\":\"1401912171,\",\"ips\":[\"1.1.1.1\",\"2.2.2.2\"],\"iss\":\"https://application-1.com\",\"iss_desc\":\"Sample application\",\"name\":\"John Doe,\",\"redirect_url\":\"https://application-1/redirect,\",\"scope\":[\"admin:users,\",\"admin:resellers\",\"admin:domains\"],\"state\":\"xyz\"},\"private_key\":\"FEF6253E6A122532430D\",\"public_key\":\"AAF6253E6A1225324305623EE\",\"token_name\":\"Application 1 API Token\"},\"name\":\"application-1\"}"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"token_name":{"type":"string","description":"The name of the API token, if any, sent to the connected application to allow that application to make API calls on this server.","example":"Application 1 API Token"},"public_key":{"example":"AAF6253E6A1225324305623EE","description":"The name of the public key, if any, sent to the connected application during registration.","type":"string"},"private_key":{"example":"FEF6253E6A122532430D","description":"The name of the private key, if any, used by encryption, signing, or other security schemes used when communicating with this connected application.","type":"string"},"jwt":{"additionalProperties":{},"type":"object","example":{"redirect_url":"https://application-1/redirect","state":"xyz","ips":["1.1.1.1","2.2.2.2"],"email":"john.doe@email.example","name":"John Doe","iss":"https://application-1.com","scope":["admin:users","admin:resellers","admin:domains"],"exp":"1401912171","callback_url":"https://application-1.com/api/si/servers/registrations/callback","challenge":"ddd13a92-d55e-4818-a960-9776ede6cd74","iss_desc":"Sample application"},"description":"The contents of a JSON Web Token used during registration or updates."}},"additionalProperties":{},"description":"Data associated with the connected application. There are predefined elements related to specific security scenarios, but additional data may be stored here as well."},"name":{"type":"string","description":"The name of the connected application.","example":"application-1"}},"type":"object"}}}},"tags":["Server Administration","Connected Applications"],"summary":"Save application connection information.","x-cpanel-api-version":"WHM API 1","operationId":"save_connected_application","description":"Save or update connection data about a specific connected application.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"save_connected_application","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"98"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Connected Applications","description":"Server Administration / Connected Applications"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.98.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2"},"retrieve_customizations":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.99.0.9999","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"tags":["Brand","Customizations"],"name":"Customizations"}],"paths":{"/retrieve_customizations":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","example":"retrieve_customizations","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"100","parameters":[{"required":"true","in":"query","name":"application","schema":{"type":"string","example":"cpanel","enum":["cpanel","webmail"]},"description":"The application name for the customization."},{"required":"true","name":"theme","in":"query","schema":{"type":"string","example":"jupiter"},"description":"The theme for the customization."}],"description":"This function retrieves customization data.\n\nCustomization data includes brand logos and colors.\n\nThis function is used to retrieve customization data for the Jupiter theme **only**.","operationId":"retrieve_customizations","x-cpanel-cli-support":"true","x-cpanel-api-version":"WHM API 1","summary":"Retrieve customization data","tags":["Customizations"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  retrieve_customizations \\\n  application='cpanel' \\\n  theme='jupiter'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/retrieve_customizations?api.version=1&application=cpanel&theme=jupiter"}]}}},"tags":[{"name":"Customizations","description":"The Customizations module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}]},"create_cphulk_record":{"paths":{"/create_cphulk_record":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","example":"create_cphulk_record","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details."}}},"data":{"properties":{"requester_ip":{"example":"10.1.4.228","description":"The IP address of the user or system that requested the addition.","anyOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]},"ips_added":{"description":"An array of IP addresses that the function added to the list.","items":{"$ref":"#/components/schemas/ip-address"},"type":"array"},"ips_failed":{"description":"A object of IP addresses that the system failed to add to the list. This object contains one or more IP address returns.","example":{"192.168.0.1":"Invalid IP address or range: \"192.68.0.1\""},"additionalProperties":{"description":"The reason why the system failed to add an IP address to the list.\n\n**Note:**\n\nThe IP address is the return's name.","type":"string"},"type":"object"},"requester_ip_is_whitelisted":{"type":"integer","description":"Whether the requester's IP address exists on cPHulk's whitelist.\n* `1` - Whitelisted.\n* `0` - Not whitelisted.","example":"0","enum":["0","1"]},"ip_blocks_removed":{"example":"1","description":"The number of IP address blocks that the function deleted.","type":"integer"},"list_name":{"example":"white","enum":["black","white"],"description":"The cPHulk list's name.\n* `black`\n* `white`","type":"string"},"comment":{"type":"string","description":"The comment that you included when you called the function.","example":"George Wendt flying through the air."},"iptable_bans_removed":{"type":"integer","minimum":"0","description":"The number of `iptables` temporary block rules that the function deleted.","example":"0"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[{"description":"The cPHulk list's name.\n\n* `black` - Add a new record or records to the blacklist.\n* `white` - Add a new record or records to the whitelist. ","schema":{"enum":["black","white"],"example":"white","type":"string"},"name":"list_name","in":"query","required":"true"},{"examples":{"multiple":{"value":["192.168.0.1","192.168.0.2","192.168.0.3"],"description":"Add multiple IP addresses."},"single":{"value":["192.168.0.1"],"description":"Add a single IP address."}},"explode":"true","schema":{"items":{"$ref":"#/components/schemas/ip-address"}},"style":"form","description":"The record's IP address, if there is only one IP address to add.\n\n**Note:**\n\nTo add multiple IP addresses, increment the parameter name. For example, `ip-1`, `ip-2`, and `ip-3`.","name":"ip","in":"query","required":"true"},{"description":"A comment to include.","schema":{"example":"George Wendt flying through the air.","type":"string","maximum":"255"},"in":"query","name":"comment","required":"false"},{"required":"false","in":"query","name":"skip_enabled_check","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to skip checking if cPHulk runs on the server.\n\n* `1` - Do **not** check if cPHulk is running.\n* `0` - Check if cPHulk is running.\n\n**Note:**\n\n If cPHulk is disabled and you check its status, the function returns the following message: `cPHulk is disabled on the server.` "}],"operationId":"create_cphulk_record","description":"This function adds a new record or records to cPHulk's whitelist or blacklist.","summary":"Add login security record to list","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  create_cphulk_record \\\n  list_name='white' \\\n  ip='192.168.0.1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/create_cphulk_record?api.version=1&list_name=white&ip=192.168.0.1"}],"tags":["cPHulk","Management"]}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Management"]}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"description":"Login Security (cPHulk) / Management","name":"Management"}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{"ip-address":{"anyOf":[{"type":"string","example":"192.168.0.1","format":"ipv4"},{"example":"192.168.0.1/30","format":"cidr","type":"string"},{"example":"192.168.0.1-192.168.0.2","format":"ipv4-ipv4","type":"string"},{"type":"string","example":"2001:db8::","format":"ipv6"},{"format":"cidr","example":"2001:db8::/32","type":"string"},{"format":"ipv6-ipv6","example":"2001:0db8::-2001:0db8:ffff:ffff:ffff:ffff:ffff:ffff","type":"string"}]}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"modsec_enable_vendor_configs":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Rule Vendor Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_enable_vendor_configs":{"get":{"summary":"Enable ModSecurity vendor configuration files","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_enable_vendor_configs \\\n  vendor_id='SomeVendor'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_enable_vendor_configs?api.version=1&vendor_id=SomeVendor"}],"tags":["ModSecurity","Rule Vendor Settings"],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"outcomes":{"items":{"properties":{"ok":{"type":"integer","description":"Whether the function successfully enabled the configuration file.\n\n* `1` — Enabled.\n* `0` — Disabled.","example":"1","enum":["1","0"]},"active":{"example":"1","enum":["1","0"],"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","type":"integer"},"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"},"config":{"description":"The configuration file path, relative to the `/usr/local/apache/conf/` directory.","example":"modsec_vendor_configs/SomeVendor/example.conf","type":"string"}},"type":"object"},"description":"An array of objects containing elements that represent the outcome of each attempt to enable operation.","type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"modsec_enable_vendor_configs","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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":[{"schema":{"type":"string","example":"SomeVendor"},"description":"The vendor's unique short name.","required":"true","name":"vendor_id","in":"query"}]}}}},"get_adjusted_market_providers_products":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/get_adjusted_market_providers_products":{"get":{"tags":["Market","Product Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_adjusted_market_providers_products\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_adjusted_market_providers_products?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return Market providers' products adjusted prices","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":[],"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","example":"get_adjusted_market_providers_products","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"products":{"description":"An array of objects that contains information about the products in the cPanel Market.","items":{"properties":{"max_users":{"nullable":"true","description":"The maximum number of users.","type":"integer","minimum":"1"},"base_name":{"description":"The base name, if one exists.","type":"string"},"product_category":{"nullable":"true","description":"The product's category.","example":"N/A","type":"string"},"minimum_server_price":{"type":"number","minimum":"0","nullable":"true","format":"currency","description":"\nThe product's minimum price.\n\n* null - The product does **not** possess a minimum price.","example":"3"},"enabled":{"example":"1","enum":["0","1"],"description":"Whether the product is enabled.\n\n* `0` - Disabled.\n* `1` - Enabled.","type":"integer"},"icon":{"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","description":"The icon to display in the product list.","type":"string"},"provider_display_name":{"example":"cPanel Store","description":"The cPanel Market provider's display name.","type":"string"},"display_name":{"type":"string","example":"Extended Validated cPanel SSL Certificate","description":"The product's display name."},"product_group":{"type":"string","description":"The product's group.","example":"ssl_certificate"},"billing_type":{"description":"The billing type.","example":"one-time","type":"string"},"requires_ip":{"enum":["0","1"],"example":"1","description":"Whether the product requires an IP.\n* `1` - Requires an IP address.\n* `0` - Does **not** require an IP address.","type":"integer"},"license_term":{"type":"integer","description":"The license term.","example":"0"},"maximum_server_price":{"example":"888.88","description":"\nThe product's maximum price.\n\n* null - The produce does **not** possess a maximum price.","format":"currency","nullable":"true","minimum":"0","type":"number"},"provider_name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"product":{"description":"The product's display name.","example":"cPanel EV Certificate","type":"string"},"icon_mime_type":{"description":"The icon's image format.","example":"image/svg+xml","type":"string"},"description":{"type":"string","description":"The product's description.","example":"Get an SSL Certificate today."},"price_unit":{"type":"string","description":"The currency code of the product's price, in [ISO-4217 format](https://en.wikipedia.org/wiki/ISO_4217) format.","example":"USD"},"recommended":{"enum":["0","1"],"example":"1","description":"Whether we recommend the product.\n* `1` - We recommend the product.\n* `0` - We do **not** recommend the product.","type":"integer"},"product_id":{"example":"209","description":"The product ID.","minimum":"1","type":"integer"},"price":{"type":"number","minimum":"0","nullable":"true","example":"6","format":"currency","description":"The product's price.\n\n* null - The product does **not** possess a static price."}},"additionalProperties":{"description":"Any product-specific additional properties. Each additional property value begins with the `x_` prefix.","x-additionalPropertiesName":"x_properties"}},"type":"array"}},"type":"object"}},"type":"object"},"examples":{"group_ssl_certificate":{"value":{"data":{"products":[{"price_unit":"USD","description":"An extended-validated (EV) SSL certificate signed by cPanel.","x_price_per_domain_minimum":"60","provider_name":"cPStore","x_max_http_redirects":"0","price":null,"product_id":"209","provider_display_name":"cPanel Store","x_certificate_term":["1","year"],"x_payment_trigger":"checkout","product_category":"N/A","base_name":"","max_users":null,"x_warn_after":"604800","license_term":"0","billing_type":"one-time","x_validation_type":"ev","product_group":"ssl_certificate","recommended":"0","x_price_per_domain_maximum":"600","icon_mime_type":"image/svg+xml","x_supports_dns_dcv":"1","product":"cPanel EV Certificate","maximum_server_price":null,"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"label":"Department Name","is_optional":"1","name":"organizationalUnitName"},{"pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","name":"duns_number","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":"1"},{"label":"Street Address","name":"streetAddress"},{"name":"localityName","label":"City"},{"label":"State or Province","name":"stateOrProvinceName"},{"name":"postalCode","label":"Postal Code"},{"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","type":"email","name":"rep_email_address"},{"label":"Representative’s Telephone Number","description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":"1","name":"rep_telephone","type":"tel"},{"type":"choose_one","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"name":"business_category","label":"Business Category","description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options."},{"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","is_optional":"1","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))","type":"country_code","name":"joi_country_name"},{"type":"date","name":"date_of_incorporation","is_optional":"1","label":"Date of Incorporation"},{"is_optional":"1","label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_ssl_per_domain_pricing":"1","enabled":"1","x_price_per_domain":"60","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","minimum_server_price":null,"requires_ip":"0","display_name":"cPanel EV SSL Certificate"}]},"metadata":{"reason":"OK","result":"1","command":"get_adjusted_market_providers_products","version":"1"}},"summary":"product_group=ssl_certificate"}}}}}}}}},"x-tagGroups":[{"tags":["Product Management"],"name":"cPanel Market"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Market module for WHM API 1.","name":"Market"},{"description":"cPanel Market / Product Management","name":"Product Management"}]},"generatesshkeypair":{"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/generatesshkeypair":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  generatesshkeypair\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/generatesshkeypair?api.version=1","label":"URL","lang":"HTTP"}],"tags":["SSH Keys and Connections"],"summary":"Create SSH key pair","x-cpanel-api-version":"WHM API 1","parameters":[{"in":"query","name":"passphrase","required":"false","description":"The key's secure passphrase.","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.","schema":{"type":"string","default":"id_rsa","example":"KeyFile"},"in":"query","name":"name","required":"false"},{"description":"The key's bits:\n\n* `1024` — The DSA algorithm's default value.\n* `2048`\n* `4096` — The RSA algorithm's default value.","schema":{"type":"integer","example":"2048","enum":["1024","2048","4096"]},"name":"bits","in":"query","required":"false"},{"schema":{"example":"dsa","enum":["rsa2","dsa"],"type":"string"},"description":"The key's encryption algorithm. The parameter defaults to the system's default algorithm.","required":"false","name":"algorithm","in":"query"},{"required":"false","name":"abort_on_existing_key","in":"query","schema":{"example":"1","enum":["0","1"],"default":"1","type":"integer"},"description":"Whether to abort the function if the user already has a key with the same name.\n\n* `1` — Abort.\n* `0` — Continue."},{"name":"comment","in":"query","required":"false","description":"A comment.","schema":{"default":"","example":"NoComment","type":"string"}}],"operationId":"generatesshkeypair","description":"This function generates an SSH key pair.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"generatesshkeypair","description":"The method name called.","type":"string"}}},"data":{"type":"object","properties":{"name":{"type":"string","description":"The key's filename.","example":"KeyFile"},"fingerprint":{"type":"string","nullable":"true","example":null,"format":"md5","description":"The key's [MD5](https://en.wikipedia.org/wiki/MD5) fingerprint."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.32"}}},"x-tagGroups":[{"name":"Authentication","tags":["SSH Keys and Connections"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Authentication / SSH Keys and Connections","name":"SSH Keys and Connections"}]},"modsec_get_configs_with_changes_pending":{"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"paths":{"/modsec_get_configs_with_changes_pending":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return staged ModSecurity configuration files","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_get_configs_with_changes_pending\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs_with_changes_pending?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.46","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"modsec_get_configs_with_changes_pending"}}},"data":{"properties":{"configs":{"type":"array","items":{"type":"string"},"description":"An array of strings containing one or more ModSecurity configuration files.","example":["modsec2.user.conf","modsec2.user1.conf","modsec2.user2.conf"]}},"type":"object"}}}}}}},"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":[]}}},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Server Settings","name":"Server Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"modsec_get_rules":{"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_get_rules":{"get":{"summary":"Return ModSecurity rules","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["ModSecurity","Rule Settings"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"modsec_get_rules","description":"The method name called.","type":"string"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"staged_changes":{"type":"integer","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"},"chunks":{"items":{"type":"object","properties":{"vendor_id":{"type":"string","example":"SomeVendor","description":"The vendor's unique short name."},"vendor_active":{"type":"integer","description":"Whether the vendor is active.\n\n* `1` — Active.\n* `0` — **Not** active.","example":"0","enum":["1","0"]},"staged":{"description":"Whether the system has added the rule to the ModSecurity configuration file.\n\n* `1` — Rule staged.\n* `0` — Rule **not** staged.","example":"0","enum":["1","0"],"type":"integer"},"disabled":{"enum":["1","0"],"example":"0","description":"Whether the rule is active.\n\n* `1` — **Not** Active.\n* `0` — Active.","type":"integer"},"meta_msg":{"example":"Denied dangerous config traffic","description":"The description of the rule.","type":"string"},"config":{"example":"modsec_vendor_configs/SomeVendor/config.conf","description":"The file path to the configuration file, relative to the `/usr/local/apache/conf/` directory.","type":"string"},"config_active":{"enum":["1","0"],"example":"0","description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","type":"integer"},"rule":{"example":"SecRule REQUEST_FILENAME \"config\" \"deny,id:662452,msg:'Denied dangerous config traffic',severity:1,auditlog\"","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.","type":"string"},"id":{"type":"integer","minimum":"1","example":"662452","description":"The ModSecurity rule's ID number.\n\n**Note:**\n\nThe function does not always return this parameter."}}},"description":"An array of objects that contains elements that represent the contents of each configuration file's rules.","type":"array"}}}}}}}}},"x-cpanel-available-version":"11.48","parameters":[{"examples":{"multiple":{"summary":"Call multiple vendors.","value":"vendor=SomeVendor,AnotherVendor"},"single":{"value":"SomeVendor","summary":"Call a single vendor."}},"description":"The vendor's unique short name.\n\n**Note:**\n\nYou can use a comma-delimited list for multiple vendors.","schema":{"type":"string"},"name":"vendor_id","in":"query","required":"false"},{"required":"false","in":"query","name":"config","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"}}},{"required":"false","name":"exclude_other_directives","in":"query","schema":{"type":"integer","example":"1","enum":["1","0"],"default":"1"},"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."},{"schema":{"type":"integer","default":"1","enum":["1","0"],"example":"1"},"description":"Whether to exclude comments that are not associated with any directives.\n\n* `1` — Exclude.\n* `0` — Do **not** exclude.","required":"false","in":"query","name":"exclude_bare_comments"}],"operationId":"modsec_get_rules","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."}}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2"},"modsec_enable_vendor":{"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"}],"paths":{"/modsec_enable_vendor":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{}},"metadata":{"properties":{"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"modsec_enable_vendor","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[{"required":"true","in":"query","name":"vendor_id","schema":{"type":"string","example":"SomeVendor"},"description":"The vendor's unique short name."}],"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","x-cpanel-api-version":"WHM API 1","summary":"Enable ModSecurity vendor rules","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_enable_vendor \\\n  vendor_id='SomeVendor'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_enable_vendor?api.version=1&vendor_id=SomeVendor","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"tags":["Rule Vendor Settings"],"name":"Web Server Security (ModSecurity)"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"force_dedistribution_from_node":{"x-tagGroups":[{"tags":["Server Nodes"],"name":"Server Administration"}],"paths":{"/force_dedistribution_from_node":{"get":{"tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  force_dedistribution_from_node \\\n  node_alias='mailalias' \\\n  user='username' user='username1'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/force_dedistribution_from_node?api.version=1&node_alias=mailalias&user=username&user=username1"}],"x-cpanel-api-version":"WHM API 1","summary":"Repair distributed accounts with data loss","description":"This function converts cPanel accounts that use a given\n[child node](https://go.cpanel.net/cPanelGlossary#child-node)\nto use the local server instead.\n\nUnlike the WHM API 1 `modifyacct` API call, this API does **not**\ntransfer users’ data from the child node as part of the conversion.\nThis API is useful for emergency repairs if, for example, a child\nnode goes permanently offline while accounts still use it.\n\n**Warning:**\n\nBecause this API does not transfer users’ data from the child node,\nall converted users will lose data. You should **only** call this API\nas a last resort.","operationId":"force_dedistribution_from_node","parameters":[{"description":"The child node’s alias (friendly name). This is the value passed in the\nWHM API 1 `link_server_node_with_api_token` function’s `alias` parameter.","schema":{"type":"string","example":"mailalias"},"in":"query","name":"node_alias","required":"true"},{"in":"query","name":"user","required":"true","description":"The usernames of the\n[distributed cPanel accounts](https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account)\nto convert.","schema":{"type":"array","items":{"type":"string"},"example":["username","username1"]}}],"x-cpanel-available-version":"94","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"log":{"description":"Log entries that indicate the conversion’s progress.","items":{"type":"object","properties":{"type":{"enum":["success","out","warn","error"],"example":"success","description":"The log level of the message.\n\n* `success` – A success message.\n* `out` – An informational message.\n* `warn` – A warning message.\n* `error` – An error message.","type":"string"},"contents":{"type":"string","example":"Converting “username1” …","description":"The message content."},"indent":{"example":"0","description":"The log message’s indent level.","type":"integer","minimum":"0"}}},"type":"array"},"user_info":{"type":"array","description":"Information about each newly-converted cPanel account.","items":{"type":"object","properties":{"username":{"type":"string","format":"username","description":"The cPanel account’s username.","example":"username1"}}}}}},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"force_dedistribution_from_node","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}}}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Server Nodes","description":"Server Administration / Server Nodes"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.93.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2"},"nginxmanager_get_cache_config_users":{"x-tagGroups":[{"tags":["NGINX Manager"],"name":"NGINX Manager"}],"paths":{"/nginxmanager_get_cache_config_users":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"example":{"users":[{"user":"cptest1","config":{"inactive_time":"60m","proxy_cache_revalidate":"on","enabled":"true","proxy_cache_lock":"on","proxy_cache_background_update":"on","zone_size":"10m","x_cache_header":"false","proxy_cache_min_uses":"1","logging":"false","proxy_cache_use_stale":"error timeout http_429 http_500 http_502 http_503 http_504","levels":"1:2"},"owner":"root","merged":"0"},{"user":"cptest2","config":{"proxy_cache_lock":"on","inactive_time":"60m","enabled":"true","proxy_cache_revalidate":"on","levels":"1:2","zone_size":"10m","proxy_cache_background_update":"on","proxy_cache_use_stale":"error timeout http_429 http_500 http_502 http_503 http_504","logging":"false","x_cache_header":"false","proxy_cache_min_uses":"1"},"owner":"root","merged":"0"}]},"properties":{"users":{"description":"An array of objects containing the user configurations.","items":{"properties":{"merged":{"type":"integer","description":"Whether the user's configuration is combined with the system and default configuration values.\n\n**Note:**\n\nThis value indicates if the function passed the `merge` flag.\n\n* `1` - The system and default configuration values are combined with the user's configuration values.\n* `0` - The system and default configuration values are not combined with the user's configuration values.","enum":["1","0"]},"config":{"description":"The user's configuration values.","additionalProperties":{"description":"The user's configuration values.\n\n**Note:**\n\nThe key names are the configuration properties. For more information, read the NGINX Caching documentation.\n\n[Nginx with Reverse Proxy | cPanel & WHM Documentation](https://go.cpanel.net/nginx-cache-settings)"},"properties":{"enabled":{"enum":["false","true"],"description":"Caching is enabled or disabled.\n\n**Note:**\n\n* `true` - Caching is enabled\n* `false` - Caching is disabled","type":"boolean"}}},"owner":{"type":"string","format":"username","description":"The reseller who owns this account."},"user":{"description":"The user's name.","format":"username","type":"string"}}}}}},"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"nginxmanager_set_config"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"name":"user","in":"query","required":"false","description":"A list of users whose cache configuration you want to retrieve.\n\n**Note:**\n\nIf you do not pass this parameter, this function retrieves the cache configuration for all users.","style":"form","schema":{"example":["unclebob","auntsue"],"default":[],"items":{"format":"username","type":"string"},"format":"username","type":"array"},"explode":"true"},{"in":"query","name":"merge","required":"false","description":"Combine default, system, and user NGINX configurations when returning configuration data.\n\n**Note:**\n\n* `1` - Return the configuration with default, system, and user values combined.","schema":{"type":"integer","example":"1","enum":["1"]}}],"description":"This function returns a user's NGINX cache configuration.","operationId":"nginxmanager_get_cache_config_users","x-cpanel-api-version":"WHM API 1","summary":"Return user NGINX caching configurations.","tags":["NGINX Manager"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  nginxmanager_get_cache_config_users\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_get_cache_config_users?api.version=1"}]}}},"tags":[{"name":"NGINX Manager","description":"The NGINX Manager module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"normalize_user_email_configuration":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Mail Server Settings","description":"Mail / Mail Server Settings"}],"paths":{"/normalize_user_email_configuration":{"get":{"summary":"Repair misconfigured email settings","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  normalize_user_email_configuration \\\n  username='username'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/normalize_user_email_configuration?api.version=1&username=username"}],"tags":["Mail","Mail Server Settings"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"normalize_user_email_configuration","description":"The method name called."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"88","parameters":[{"schema":{"type":"string","example":"username"},"description":"The cPanel account's username.","required":"true","name":"username","in":"query"}],"operationId":"normalize_user_email_configuration","description":"This function fixes a user's misconfigured email settings. This includes any misconfigured email file and directory ownership and permissions."}}},"x-tagGroups":[{"name":"Mail","tags":["Mail Server Settings"]}],"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"verify_oscar_access":{"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}],"paths":{"/verify_oscar_access":{"get":{"x-cpanel-available-version":"11.52–68","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message_id":{"example":"554d2cbd-efe61da3cacb","description":"The test message's ID. A valid string.","type":"string"}}},"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"verify_oscar_access","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"description":"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.\n\nYou can also review the user's ICQ message history to confirm that the server sent and received the message.\n\nThe test's success or failure depends on the following conditions:\n* Valid username and password combination.\n* Network configuration.\n* Service outages.\n* External server rate limit.\n\n**Warning:**\n\n  AOL discontinued support for AIM in December 2017. This function only tests ICQ credentials, not AIM credentials.","operationId":"verify_oscar_access","parameters":[{"required":"true","in":"query","name":"username","schema":{"type":"string","example":"username"},"description":"The ICQ account.\n\n**Notes:**\n\n* 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.\n* You **cannot** use this function to test an AIM account."},{"required":"true","name":"password","in":"query","schema":{"type":"string","example":"12345luggage"},"description":"The ICQ account's password.\n\n  **Note:**\n\nYou **cannot** use this function to test an AIM account."}],"x-cpanel-api-version":"WHM API 1","summary":"Validate ICQ username and password","tags":["Server Administration","Notifications"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  verify_oscar_access \\\n  username='username' \\\n  password='12345luggage'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_oscar_access?api.version=1&username=username&password=12345luggage","label":"URL","lang":"HTTP"}]}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Notifications","name":"Notifications"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"list_connected_applications":{"x-tagGroups":[{"tags":["Connected Applications"],"name":"Server Administration"}],"paths":{"/list_connected_applications":{"post":{"operationId":"list_connected_applications","description":"Retrieve the connection information for all the connected applications that have been\ngranted access to this server. This data may include any number of properties, but its\nprimary purpose is to associate API tokens and public/private key pairs and similar\nresources with a specific connected application.","tags":["Server Administration","Connected Applications"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_connected_applications\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_connected_applications?api.version=1"}],"x-cpanel-available-version":"98","x-cpanel-api-version":"WHM API 1","summary":"List application connection information","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"list_connected_applications"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"list":{"description":"The list of connected applications and their associated data.","items":{"description":"Data associated with the connected application. There are a few predefined elements, but any additional data may be stored here as well.","type":"object","additionalProperties":{},"properties":{"name":{"example":"application-1","description":"The name of the connected application.","type":"string"},"jwt":{"additionalProperties":{},"type":"object","example":{"redirect_url":"https://application-1/redirect","state":"xyz","ips":["1.1.1.1","2.2.2.2"],"exp":"1401912171","callback_url":"https://application-1.com/api/si/servers/registrations/callback","iss":"https://application-1.com","name":"John Doe","email":"john.doe@email.example","scope":["admin:users","admin:resellers","admin:domains"],"iss_desc":"Sample application","challenge":"ddd13a92-d55e-4818-a960-9776ede6cd74"},"description":"The contents of a JSON Web Token used during registration or updates."},"token_name":{"description":"The name of the API token, if any, sent to the connected application to allow that application to make API calls on this server.","example":"Application 1 API Token","type":"string"},"public_key":{"description":"The name of the public key, if any, sent to the connected application during registration.","example":"AAF6253E6A1225324305623EE","type":"string"},"private_key":{"type":"string","description":"The name of the private key, if any, used by encryption, signing, or other security schemes used when communicating with this connected application.","example":"FEF6253E6A122532430D"}}},"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Connected Applications","name":"Connected Applications"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.98.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"enable_mail_sni":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/enable_mail_sni":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"updated_domains":{"type":"object","description":"An object containing the domains with updated mail SNI status.\n**Note:**\nThis object is always empty. Mail SNI is always enabled, and this function makes no changes.","example":{}},"failed_domains":{"description":"An object containing the domains that failed to enable mail SNI.\n**Note:**\nThis object only includes domains that you do not own.","additionalProperties":{"type":"string","description":"The reason the domain failed to enable mail SNI.\n\n**Note:**\n\nThe domain name is the return key."},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","example":"enable_mail_sni","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"warnings":{"items":{"example":"Mail SNI is always enabled now.","type":"string"},"description":"Warnings generated while running the function.","type":"array"},"reason":{"type":"string","example":"OK","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."}}}}}}}}},"x-cpanel-available-version":"11.48","parameters":[{"required":"true","in":"query","name":"domain","schema":{"example":"example.com","type":"string"},"description":"The account's domain. You may pass multiple domains using additional numbered parameters (e.g., `domain-1`, `domain-2`)."}],"description":"This function enables SNI for mail services on the specified domains.\n\n**Note:**\n\nMail SNI is **always** enabled.\n\n* Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.\n* Functions that disable Mail SNI fail and make no changes.","operationId":"enable_mail_sni","x-cpanel-api-version":"WHM API 1","summary":"Enable SNI mail services for domains","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enable_mail_sni \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_mail_sni?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"name":"Mail","tags":["Mail Server Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Mail Server Settings","description":"Mail / Mail Server Settings"}]},"package_manager_upgrade":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"name":"System Package Management","tags":["Install or Uninstall Package"]}],"paths":{"/package_manager_upgrade":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"build":{"description":"A valid Process ID (PID).","example":"10111","type":"integer"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"package_manager_upgrade","description":"The method name called.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"54","parameters":[],"description":"This function downloads and installs package updates on the server.","operationId":"package_manager_upgrade","x-cpanel-api-version":"WHM API 1","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"}]}}},"tags":[{"description":"The RPM module for WHM API 1.","name":"RPM"},{"name":"Install or Uninstall Package","description":"System Package Management / Install or Uninstall Package"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}]},"remote_mysql_read_profile":{"x-tagGroups":[{"tags":["Remote MySQL Databases"],"name":"Databases"}],"paths":{"/remote_mysql_read_profile":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"example":"remote_mysql_read_profile","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"type":"object","properties":{"profile_name":{"description":"The MySQL profile's name.","example":"MyProfile","type":"string"},"profile_details":{"type":"object","properties":{"mysql_port":{"minimum":"1","maximum":"65535","type":"integer","example":"3306","description":"The MySQL server's port number."},"mysql_pass":{"type":"string","example":"123456luggage","description":"The MySQL server's password."},"active":{"example":"0","enum":["1","0"],"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.","type":"integer"},"setup_via":{"description":"A description of the MySQL profile data.","example":"Main terminal","type":"string","maxLength":"255"},"mysql_host":{"oneOf":[{"type":"string","example":"192.168.0.1","description":"A valid IP address.","format":"ipv4"},{"example":"hostname.example.com","format":"hostname","description":"A valid hostname.","type":"string"}],"type":"string","description":"The MySQL server's IP address or hostname."},"mysql_user":{"example":"username","description":"The MySQL server's username.","type":"string"}},"description":"An object containing the profile's data."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.52","parameters":[{"required":"true","in":"query","name":"name","schema":{"type":"string","example":"MyProfile"},"description":"The MySQL profile's name."}],"description":"This function displays the details of a specified remote MySQL® profile.","operationId":"remote_mysql_read_profile","summary":"Return remote MySQL profile","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_read_profile \\\n  name='MyProfile'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_read_profile?api.version=1&name=MyProfile","label":"URL","lang":"HTTP"}],"tags":["Databases","Remote MySQL Databases"]}}},"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"description":"Databases / Remote MySQL Databases","name":"Remote MySQL Databases"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"modsec_deploy_all_rule_changes":{"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}],"paths":{"/modsec_deploy_all_rule_changes":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  modsec_deploy_all_rule_changes\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_deploy_all_rule_changes?api.version=1"}],"tags":["ModSecurity","Rule Settings"],"summary":"Enable all staged ModSecurity rule changes","x-cpanel-api-version":"WHM API 1","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":[],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"outcomes":{"items":{"type":"object","properties":{"ok":{"type":"integer","description":"Whether the rule change deployment succeeded.\n\n* `1` — Successful deployment.\n* `0` — Unsuccessful deployment.","example":"0","enum":["1","0"]},"config":{"example":"modsec_vendor_configs/MyVendor/one.conf","description":"The file path to the configuration file.\n\n* EasyApache 4 — A valid path, relative to the `/etc/apache2/conf.d/modsec/` directory.","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"}}},"description":"An array of objects containing information about the configuration deployment.","type":"array"},"failed":{"items":{"type":"string","example":"modsec_vendor_configs/MyVendor/one.conf"},"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.","type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"modsec_deploy_all_rule_changes"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Settings"]}]},"get_cphulk_failed_logins":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Reporting","name":"Reporting"}],"paths":{"/get_cphulk_failed_logins":{"get":{"summary":"Return login security failed logins","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_cphulk_failed_logins\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_cphulk_failed_logins?api.version=1","lang":"HTTP","label":"URL"}],"tags":["cPHulk","Reporting"],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"get_cphulk_failed_logins","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"properties":{"failed_logins":{"items":{"type":"object","properties":{"user":{"type":"string","description":"The login attempt's username.","example":"example"},"timeleft":{"example":"14","description":"The number of minutes that remain before cPHulk removes the block.","minimum":"1","type":"integer"},"authservice":{"type":"string","description":"The name of the authentication service that the login attempt used.","example":"dovecot"},"logintime":{"type":"string","example":"2014-11-20T00:00:00.000Z","description":"When the login attempt occurred.","format":"ISO-8601 Date Time (Space Separated)"},"exptime":{"type":"string","example":"2014-12-07T00:00:00.000Z","description":"When the login request will time out.","format":"ISO-8601 Date Time (Space Separated)"},"service":{"type":"string","example":"ftp","description":"The login attempt's service. name."},"ip":{"description":"The login attempt's IP address.","example":"192.168.0.1","anyOf":[{"type":"string","format":"ipv4"},{"format":"ipv6","type":"string"}]}}},"description":"Information about each failed login attempt.","type":"array"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"operationId":"get_cphulk_failed_logins","description":"This function lists failed login attempt entries from the cPHulk database.","parameters":[]}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Reporting"]}]},"get_users_links":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Accounts","tags":["Styles"]}],"paths":{"/get_users_links":{"get":{"x-cpanel-available-version":"11.50","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"get_users_links","description":"The method name called.","type":"string"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"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"},"type":"object","description":"A list of appkeys and their corresponding file locations.","example":{"Email_BoxTrapper":"frontend/jupiter/mail/boxtrapper.html","Email_Archive":"frontend/jupiter/mail/archive.html","Email_Authentication":"frontend/jupiter/mail/auth.html","Backups_Home":"frontend/jupiter/backup/index.html","Cron_Home":"frontend/jupiter/cron/index.html","Email_Disk_Usage":"frontend/jupiter/mail/manage_disk_usage/","Calendar_Configure":"frontend/jupiter/mail/calendars_and_contacts/index.html","Email_AccountLevelFiltering":"frontend/jupiter/mail/filters/userfilters.html","Email_SpamFilter":"frontend/jupiter/mail/spam/spam.html","Email_DeliveryReport":"frontend/jupiter/mail/def.html","Locale_Change":"frontend/jupiter/setlang/index.html","Email_Forwarders":"frontend/jupiter/mail/fwds.html","Email_UserLevelFiltering":"frontend/jupiter/mail/filters/managefilters.html","SSL_TLS_Manager":"frontend/jupiter/ssl/index.html","Email_AutoResponders":"frontend/jupiter/mail/autores.html","Stats_AWStats":"frontend/jupiter/stats/awstats_landing.html","Database_phpMyAdmin":"frontend/jupiter/sql/PhpMyAdmin.html","Email_Accounts":"frontend/jupiter/mail/pops/index.html","ContactInfo_Change":"frontend/jupiter/contact/index.html","Email_Routing":"frontend/jupiter/mail/email_routing.html","FileManager_Home":"frontend/jupiter/filemanager/index.html","SSL_TLS_Status":"frontend/jupiter/security/tls_status/","Database_MySQL":"frontend/jupiter/sql/index.html","Password_Change":"frontend/jupiter/passwd/index.html","Email_MailingLists":"frontend/jupiter/mail/lists.html","SSL_TLS_Wizard":"frontend/jupiter/security/tls_wizard/","Email_DefaultAddress":"frontend/jupiter/mail/def.html","Email_GreyListing":"frontend/jupiter/mail/greylisting/index.html","Site_Software":"frontend/jupiter/addoncgi/cpaddons.html","Solr_Disk_Usage":"frontend/jupiter/mail/search_index/"}}}}}}}},"operationId":"get_users_links","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.","parameters":[{"description":"The requested user's username.","schema":{"type":"string","example":"user"},"name":"user","in":"query","required":"true"},{"description":"The interface for which to filter results:\n\n* `cpanel` — cPanel\n* `webmail` — Webmail","schema":{"type":"string","example":"cpaneld","enum":["cpaneld","webmail"],"default":"cpaneld"},"in":"query","name":"service","required":"false"}],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_links?api.version=1&user=user","label":"URL","lang":"HTTP"}]}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Styles","description":"Server Administration / Account Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}]},"release_outgoing_email":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"paths":{"/release_outgoing_email":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Release cPanel account queued outgoing emails","x-cpanel-api-version":"WHM API 1","operationId":"release_outgoing_email","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.","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account.","schema":{"example":"example","type":"string"}}],"x-cpanel-available-version":"56","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"release_outgoing_email","description":"The method name called.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}]},"remove_override_features_for_user":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"name":"Feature Access","description":"Hosting Plans / Feature Access"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Access"]}],"paths":{"/remove_override_features_for_user":{"get":{"parameters":[{"in":"query","name":"user","required":"true","description":"The user's username.","schema":{"type":"string","example":"username","format":"username"}},{"content":{"application/json":{"schema":{"type":"array","example":["sslinstall","videotut"],"items":{"type":"string"}}}},"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.","required":"true","name":"features","in":"query"}],"description":"This function removes feature overrides from a cPanel account.","operationId":"remove_override_features_for_user","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"remove_override_features_for_user","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"56","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"},{"lang":"HTTP","label":"URL","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","summary":"Remove cPanel account feature list overrides"}}}},"updateuserdomains":{"x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"paths":{"/updateuserdomains":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update /etc/userdomains file","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  updateuserdomains\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/updateuserdomains?api.version=1"}],"x-cpanel-available-version":"86","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"updateuserdomains","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"description":"This function updates the `/etc/userdomains` file based on the entries in `/var/cpanel/users` directory.","operationId":"updateuserdomains","parameters":[]}}},"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"Domain Management","description":"DNS / Domain Management"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"update_sql_config":{"x-tagGroups":[{"tags":["Manage MySQL Server"],"name":"Databases"}],"paths":{"/update_sql_config":{"post":{"description":"This function updates the database configuration file for 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":"update_sql_config","x-cpanel-available-version":"cPanel 11.100","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"update_sql_config","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"requestBody":{"content":{"application/json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"example":{"value":"268435456","name":"max_allowed_packet","section":"mysqld"},"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"section":{"type":"string"},"remove":{"type":"boolean"}}},"description":"Array of objects that contains the requested updates to the sql configuration."}}}}},"required":"true"},"tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"source":"echo '{\"data\" : [{ \"name\" : \"open_files_limit\", \"value\" : \"9999\", \"section\" : \"mysqld\" }]}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n  update_sql_config\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_sql_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Update the servers SQL configuration."}}},"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"Manage MySQL Server","description":"Databases / Manage MySQL Server"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.99.0.9999","description":"WHM API."},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"backup_set_list_combined":{"paths":{"/backup_set_list_combined":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_set_list_combined\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_set_list_combined?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Backups","Backup or Restore"],"summary":"Return backup files for the server's accounts","x-cpanel-api-version":"WHM API 1","parameters":[],"description":"This function lists locally-stored and backup-destination stored backup files for the server's accounts.","operationId":"backup_set_list_combined","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"backup_set":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"when":{"type":"string","example":"2020-09-01T00:00:00.000Z","format":"ISO-8601 Date","description":"The date the backup was created."},"where":{"type":"string","example":"local","enum":["local","remote"],"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."}},"description":"An object containing the time and location backup information."},"format":"username","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."},"example":{"cpusername1":[{"when":"2020-01-25T00:00:00.000Z","where":"local"},{"where":"local","when":"2020-01-26T00:00:00.000Z"}],"cpusername2":[{"where":"local","when":"2020-01-25T00:00:00.000Z"},{"where":"local","when":"2020-01-26T00:00:00.000Z"}]},"description":"An object that contains an object of backup destination information."},"destination_legend":{"example":{"GLT1vFsVO8cqk2UWWFpJ9kSQ":{"name":"More Backups","type":"Local"}},"description":"An object containing objects that contain the backup's destination and type information.","type":"object","additionalProperties":{"properties":{"type":{"type":"string","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"},"name":{"type":"string","description":"The backup destination's name.","example":"More Backups"}},"type":"object","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."}}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","example":"1","enum":["1","0"]},"command":{"type":"string","example":"backup_set_list_combined","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"80"}}},"x-tagGroups":[{"tags":["Backup or Restore"],"name":"Backups"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Backups module for WHM API 1.","name":"Backups"},{"description":"Backups / Backup or Restore","name":"Backup or Restore"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"modsec_remove_setting":{"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/modsec_remove_setting":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_setting?api.version=1&setting_id=3"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"modsec_remove_setting"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.46","parameters":[{"schema":{"example":"3","type":"integer"},"description":"The setting's ID. For a list of available settings and their IDs, call the `modsec_get_settings` function.","required":"true","in":"query","name":"setting_id"}],"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"}}},"x-tagGroups":[{"tags":["Server Settings"],"name":"Web Server Security (ModSecurity)"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}]},"get_integration_link_user_config":{"tags":[{"description":"The Integration module for WHM API 1.","name":"Integration"},{"description":"Integrations / Links","name":"Links"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Links"],"name":"Integrations"}],"paths":{"/get_integration_link_user_config":{"get":{"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"userconfig":{"type":"object","properties":{"url":{"example":"http://www.example.com","format":"url","description":"A publicly-available URL to which to send the user if the\nlocation in the `autologin_token_url` parameter does not\nrespond.","type":"string"},"subscriber_unique_id":{"example":"1234","description":"The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.","type":"string"},"user":{"type":"string","example":"username","format":"username","description":"The cPanel account name."},"autologin_token_url":{"example":"http://www.example.com/login.cgi","format":"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).","type":"string"},"app":{"example":"WHMCS_billing","description":"The application to link.","type":"string"},"base64_png_image":{"type":"string","description":"The image to display for the application on the cPanel *Home* interface.","format":"base64 image","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"},"label":{"type":"string","example":"WHMCS Billing","description":"The label to display for the application on the cPanel *Home* interface."},"implements":{"example":"billing","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.","type":"string"}},"description":"An object with information about the user's integration link."}}},"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"get_integration_link_user_config"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"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":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"username","format":"username"},"description":"The cPanel account name."},{"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.","schema":{"example":"WHMCS_billing","type":"string"},"name":"app","in":"query","required":"true"}],"summary":"Return integration link configuration","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_integration_link_user_config \\\n  user='username' \\\n  app='WHMCS_billing'\n","lang":"Shell","label":"CLI"},{"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"}],"tags":["Integration","Links"]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"}},"set_mysql_password":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"MySQL Databases","description":"Databases / MySQL Databases"}],"paths":{"/set_mysql_password":{"get":{"parameters":[{"schema":{"type":"string","format":"username","example":"username"},"description":"The database username. For information about database username\nrestrictions, read the\n[MySQL](https://dev.mysql.com/) and [MariaDB](https://mariadb.org/)\ndocumentation.","required":"true","in":"query","name":"user"},{"schema":{"type":"string","example":"123456luggage"},"description":"The database user's new password.","required":"true","in":"query","name":"password"},{"required":"false","name":"cpuser","in":"query","schema":{"type":"string","format":"username","example":"example"},"description":"The cPanel user that controls the database user."}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"set_mysql_password","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"11.44","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_mysql_password?api.version=1&user=username&password=123456luggage","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update MySQL user password"}}},"x-tagGroups":[{"name":"Databases","tags":["MySQL Databases"]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"twofactorauth_remove_user_config":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}],"paths":{"/twofactorauth_remove_user_config":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_remove_user_config \\\n  user='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_remove_user_config?api.version=1&user=example.com","label":"URL","lang":"HTTP"}],"tags":["Authentication","Two-Factor Authentication"],"summary":"Remove 2FA settings","x-cpanel-api-version":"WHM API 1","operationId":"twofactorauth_remove_user_config","description":"This function removes the Two-Factor Authentication (2FA) settings for one or more specified user accounts.\n\n**Note:**\n\nIf you remove the 2FA settings for an account, the user **must** perform the setup procedure again to re-configure 2FA on the account.","parameters":[{"schema":{"type":"string"},"examples":{"single":{"description":"A single user.","value":"example.com"},"multiple":{"value":"user-1=username1 user-2=username2 user-3=username3","description":"Multiple users."}},"description":"The account's username.\n\n**Note:**\n\n To remove multiple users, increment the parameter name. For example, `user-1`, `user-2`, or `user-3`.","required":"true","name":"user","in":"query"}],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"users_modified":{"description":"An array of the user accounts for which you successfully removed 2FA settings.","items":{"example":"example","type":"string"},"type":"array"},"failed":{"additionalProperties":{"example":"You are not authorized to modify example","description":"The reason for the failure.\n\n**Note:**\n\nThe user's name is the return name.","type":"string","x-additionalPropertiesName":"username"},"type":"object","description":"An object that contains the user accounts for which removal failed."}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","description":"The method name called.","example":"twofactorauth_remove_user_config"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}}}}},"description":"HTTP Request was successful."}}}}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"Two-Factor Authentication","description":"Authentication / Two-Factor Authentication"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"restore_queue_list_active":{"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Reporting"]}],"paths":{"/restore_queue_list_active":{"get":{"tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_list_active\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_list_active?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return active restoration tasks list","description":"This function lists the tasks that the restoration queue is actively processing.","operationId":"restore_queue_list_active","parameters":[],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"restore_job":{"type":"array","items":{"properties":{"user":{"example":"username","description":"The cPanel account's username.","type":"string"},"restore_point":{"format":"ISO-8601 Date","description":"The date of the backup that the task will use, in `YYYY-MM-DD` format.","example":"2019-10-21T00:00:00.000Z","type":"string"},"options":{"description":"A list of information about an active task in the restoration queue.","properties":{"subdomains":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether the function will restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Will **not** restore."},"mysql":{"description":"Whether the task will restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","example":"1","enum":["0","1"],"type":"integer"},"destid":{"type":"string","example":"local","description":"The backup location from which to restore the data."},"mail_config":{"enum":["0","1"],"example":"1","description":"Whether the function will restore the account's email configuration.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","type":"integer"},"give_ip":{"type":"integer","description":"Whether the task will assign the account a dedicated IP address.\n\n* `1` — Assign.\n* `0` — Will **not** assign.","example":"1","enum":["0","1"]}},"type":"object"}},"type":"object"},"description":"An array of objects that contain information about an active task in the restoration queue."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"restore_queue_list_active","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}}}}},"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"name":"Restore Queue Reporting","description":"Account Restoration / Restore Queue Reporting"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2"},"get_in_product_survey_url":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"openapi":"3.0.2","x-tagGroups":[{"tags":["InProductSurvey"],"name":"InProductSurvey"}],"paths":{"/get_in_product_survey_url":{"get":{"operationId":"get_in_product_survey_url","description":"This function returns whether to display the in-product survey banner and the survey link.","parameters":[],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"user_type":{"type":"string","example":"whm","enum":["whm"],"description":"The user context type. Always \"whm\" for this endpoint."},"max_dismiss":{"description":"Maximum number of times the banner may be dismissed before it is suppressed.","example":"3","type":"string"},"link":{"type":"string","description":"The fully-resolved survey URL.","example":"https://example.com/survey?token=ABC123"},"submit_event":{"type":"string","example":"survey_submitted","description":"Event identifier emitted on successful survey submission for analytics."},"server_type":{"description":"Product/server type identifier.","example":"whm","type":"string"},"new_user":{"type":"string","enum":["0","1"],"example":"0","description":"Indicates whether the authenticated user is considered new.\n* `1` — New user.\n* `0` — Existing user."},"display":{"type":"string","example":"1","enum":["0","1"],"description":"Indicates whether the banner should be displayed.\n* `1` — Display the banner.\n* `0` — Do not display the banner."}},"type":"object"},"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"get_in_product_survey_url","description":"The method name called.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","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.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_in_product_survey_url"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_in_product_survey_url?api.version=1","label":"URL","lang":"HTTP"}],"tags":["InProductSurvey"],"summary":"Get in-product survey URL","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"InProductSurvey","description":"In-product survey information."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}]},"rebuildinstalledssldb":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"SSL Server Settings","description":"SSL Certificates / SSL Server Settings"}],"paths":{"/rebuildinstalledssldb":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Rebuild installed SSL database (no-op)","tags":["SSL","SSL Server Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  rebuildinstalledssldb\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/rebuildinstalledssldb?api.version=1"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"metadata":{"properties":{"warnings":{"description":"Warnings generated while running the function.","items":{"type":"string","example":"This function is now a no-op."},"type":"array"},"reason":{"example":"OK","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.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"rebuildinstalledssldb","description":"The method name called.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.36","parameters":[],"description":"This function is a no-op and performs no actions.\n\n**Note:**\n\nThis function previously rebuilt the database of installed SSL certificates,\nbut this operation is no longer necessary and the function always succeeds\nwithout taking any action.","operationId":"rebuildinstalledssldb"}}},"x-tagGroups":[{"tags":["SSL Server Settings"],"name":"SSL Certificates"}]},"mail_sni_status":{"x-tagGroups":[{"tags":["Mail Server Settings"],"name":"Mail"}],"paths":{"/mail_sni_status":{"get":{"tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  mail_sni_status \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/mail_sni_status?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","summary":"Return domain's SNI mail services status","description":"This function retrieves the status of the domain's SNI mail services.\n\n**Note:**\n\nFunctions that disable Mail SNI fail and make no changes.","operationId":"mail_sni_status","parameters":[{"description":"The account's domain.","schema":{"type":"string","example":"example.com"},"in":"query","name":"domain","required":"true"}],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","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."},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","example":"mail_sni_status","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"properties":{"enabled":{"description":"Whether SNI for mail is enabled.\n- `1` — Enabled.\n- `0` — Disabled.","example":"1","enum":["0","1"],"type":"integer"}},"type":"object"}}}}},"description":"HTTP Request was successful."}}}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Mail Server Settings","description":"Mail / Mail Server Settings"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"restore_queue_is_active":{"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"name":"Restore Queue Reporting","description":"Account Restoration / Restore Queue Reporting"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Restore Queue Reporting"],"name":"Account Restoration"}],"paths":{"/restore_queue_is_active":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"is_active":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the restoration queue is actively processing tasks.\n\n* `1` — Currently active.\n* `0` — **Not** currently active."}}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"restore_queue_is_active"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38","parameters":[],"operationId":"restore_queue_is_active","description":"This function checks whether the system's restoration queue is actively processing tasks.","summary":"Validate restoration queue is active","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_is_active\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_is_active?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Account Restoration","Restore Queue Reporting"]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"backup_skip_users_all":{"paths":{"/backup_skip_users_all":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup","lang":"HTTP","label":"URL"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","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"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"backup_skip_users_all","description":"The method name called.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38","parameters":[{"required":"true","in":"query","name":"state","schema":{"example":"1","enum":["0","1"],"type":"integer"},"description":"Whether to enable the backup type that the `backupversion` parameter\nspecifies for all users.\n  * `1` - Enable.\n  * `0` - Disable."},{"name":"backupversion","in":"query","required":"true","description":"The type of backup.\n  * `backup` - Standard backups.\n  * `legacy` - Legacy backups.","schema":{"example":"backup","enum":["backup","legacy"],"type":"string"}}],"operationId":"backup_skip_users_all","description":"This function enables and disables the backup and legacy backups."}}},"x-tagGroups":[{"tags":["Backup Settings"],"name":"Backups"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup Settings","name":"Backup Settings"}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"remote_mysql_initiate_profile_activation":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"tags":["Remote MySQL Databases"],"name":"Databases"}],"paths":{"/remote_mysql_initiate_profile_activation":{"get":{"parameters":[{"name":"name","in":"query","required":"true","description":"The profile's name.","schema":{"type":"string","example":"MyProfile"}}],"description":"This function initiates the activation process for a remote MySQL® profile.","operationId":"remote_mysql_initiate_profile_activation","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"activation_job_started":{"example":"8093","description":"The profile activation's process ID.","minimum":"1","type":"integer"}}},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"remote_mysql_initiate_profile_activation"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"11.52","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_initiate_profile_activation \\\n  name='MyProfile'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_initiate_profile_activation?api.version=1&name=MyProfile"}],"tags":["Databases","Remote MySQL Databases"],"summary":"Start remote MySQL profile activation","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"Remote MySQL Databases","description":"Databases / Remote MySQL Databases"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"ea4_list_profiles":{"paths":{"/ea4_list_profiles":{"get":{"tags":["EasyApache","EasyApache Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  ea4_list_profiles\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_list_profiles?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return EasyApache 4 profiles","operationId":"ea4_list_profiles","description":"This function returns a list of all [EasyApache 4](https://docs.cpanel.net/ea4/) profiles and the packages that each profile provides.\n\n **Important:**\n\n When you disable the [Web Server](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) role, the system **disables** this function.","parameters":[],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","description":"**Note:**\n\n* This function returns this array when a third-party vendor-created profile exists.\n* The function may return this array multiple times.","items":{"type":"object","properties":{"path":{"type":"string","example":"default.json","description":"The file name of the profile."},"name":{"description":"The profile name.","example":"No PHP","type":"string"},"desc":{"type":"string","example":"The currently installed packages on the server.","description":"A description of the profile."},"validation_data":{"properties":{"not_on_server":{"type":"array","items":{"type":"string"},"description":"An array of packages in the profile that do not exist in any of the server's yum repositories.","example":["ea-apache24","ea-php74"]}},"type":"object"},"pkgs":{"items":{"type":"string"},"description":"An array of RPM packages that the profile includes.","example":["ea-apache24","ea-php74"],"type":"array"},"version":{"example":"1.2","description":"The profile's current version ID.","type":"string"},"tags":{"type":"array","example":["ea-apache24","ea-php74"],"items":{"type":"string"},"description":"Labels that highlight key attributes of a profile."}}}},"properties":{"cpanel":{"type":"array","items":{"type":"object","properties":{"version":{"example":"1.2","description":"The profile's current version ID.","type":"string"},"tags":{"example":["ea-apache24","ea-php74"],"description":"Labels that highlight key attributes of a profile.","items":{"type":"string"},"type":"array"},"pkgs":{"type":"array","example":["ea-apache24","ea-php74"],"description":"An array of RPM packages that the profile includes.","items":{"type":"string"}},"desc":{"example":"The currently installed packages on the server.","description":"A description of the profile.","type":"string"},"validation_data":{"properties":{"not_on_server":{"type":"array","description":"An array of packages in the profile that do not exist in any of the server's yum repositories.","items":{"type":"string"},"example":["ea-apache24","ea-php74"]}},"type":"object"},"active":{"type":"integer","description":"Whether the cPanel & WHM-provided EasyApache 4 profile's settings are active.\n* `1` - Active.\n* `0` - Inactive.","example":"1","enum":["0","1"]},"name":{"type":"string","description":"The profile name.","example":"No PHP"}}},"description":"An array of cPanel & WHM-provided EasyApache 4 profile settings objects."},"custom":{"type":"array","description":"An array of custom settings objects.\n\n**Note:**\n\nThis function returns the custom array when a system administrator-created profile exists.","items":{"type":"object","properties":{"pkgs":{"example":["ea-apache24","ea-php74"],"items":{"type":"string"},"description":"An array of RPM packages that the profile includes.","type":"array"},"version":{"type":"string","description":"The profile's current version ID.","example":"1.2"},"tags":{"type":"array","example":["Apache 2.4","PHP 7.4"],"description":"Labels that highlight key attributes of a profile.","items":{"type":"string"}},"path":{"type":"string","example":"default.json","description":"The file name of the profile."},"name":{"description":"The profile name.","example":"No PHP","type":"string"},"desc":{"type":"string","example":"The currently installed packages on the server.","description":"A description of the profile."},"validation_data":{"properties":{"not_on_server":{"items":{"type":"string"},"description":"An array of packages in the profile that do not exist in any of the server's yum repositories.","example":["ea-apache24","ea-php74"],"type":"array"}},"type":"object"}}}}}},"metadata":{"properties":{"result":{"description":"- 1 - Success.\n- 0 - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","description":"The method name called.","example":"ea4_list_profiles"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["EasyApache Settings"],"name":"Web Server Configuration"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"EasyApache","description":"The EasyApache module for WHM API 1."},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"validate_current_dkims":{"x-tagGroups":[{"name":"Mail","tags":["Mail DNS Settings"]}],"paths":{"/validate_current_dkims":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  validate_current_dkims \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_dkims?api.version=1&domain=example.com"}],"tags":["Mail","Mail DNS Settings"],"summary":"Validate DKIM records","x-cpanel-api-version":"WHM API 1","parameters":[{"examples":{"single":{"summary":"Check the DKIM records for a single domain.","value":"example.com"},"multiple-alternative":{"value":"domain=example.com&domain=example2.com&domain=example3.com","summary":"Check the DKIM records for multiple domains."},"multiple":{"value":"domain-1=example.com&domain-2=example.com&domain-3=example3.com","summary":"Check the DKIM records for multiple domains."}},"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.","schema":{"type":"string"},"in":"query","name":"domain","required":"true"}],"description":"This function retrieves and checks the DomainKeys Identified Mail (DKIM) records for one or more domains.","operationId":"validate_current_dkims","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payload":{"items":{"type":"object","properties":{"records":{"type":"array","items":{"properties":{"state":{"type":"string","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"]},"current":{"type":"string","description":"The full contents of the domain's `DKIM TXT` record data."}},"type":"object"},"description":"The domain's DNS `DKIM TXT` records."},"domain":{"description":"The domain that the function used to check the DKIM record with a `default._domainkey` prefix.","type":"string"},"validity_cache_update":{"type":"string","enum":["set","valid","none","error"],"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."},"expected":{"description":"The DKIM record's contents.","type":"string"},"error":{"type":"string","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."},"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"}}},"description":"An array of objects containing information about the domain's DKIM records.","example":[{"validity_cache_update":"valid","expected":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\","state":"VALID","domain":"default._domainkey.example.com","records":[{"state":"VALID","current":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\"}]},{"domain":"default._domainkey.example2.com","records":[],"validity_cache_update":"none","expected":"v=DKIM1; k=rsa; p=MIIBIjAAAgkrhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4mA8NH3BkYvOmB0+ll23U78JesahG8304unKhW+MAm0ZE+i6EWN6iXhUj7FRPvI/6jFRd7qAHCPKFLo5+/PTy8C8eK312tfSnF3N0eucYFbgZ8F8iSRdgrcgEjvJ1vM1uvcUF211yd/e3jxT2Ge4/fmZcTYNjfH3uAuriv61L6pdIwHUWPhcjQvgOQoKQgXgooCUbUkWFDkMAH+EF/0g1dnXf289LjlvQsKhY7Y135Zpvm21kjUcj5mrLDlHJALzCVb8K/r/LCxjV5GFUyJiiNLAxkI9V1vZ4pMQvKIsN7wzu6gXK87w6mEWvKvipMAP8A2choDrk6H/fcQtfNodgwIDADAB;","error":"(XID 4krw35) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “default._domainkey.example2.com”’s “TXT” records.","state":"ERROR"}]}}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"command":{"type":"string","example":"validate_current_dkims","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"78"}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Mail DNS Settings","description":"Mail / Mail DNS Settings"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"ticket_whitelist_setup":{"tags":[{"name":"Support Tickets","description":"The Support Tickets module for WHM API 1."},{"description":"cPanel Support Tickets / Support Access","name":"Support Access"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"cPanel Support Tickets","tags":["Support Access"]}],"paths":{"/ticket_whitelist_setup":{"get":{"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"chain_status":{"type":"string","description":"A message that indicates whether the whitelist setup succeeded.\n\n* `ACTIVE` — A successful setup.\n* `ERR_SETUP` — An error occurred.","enum":["ACTIVE","ERR_SETUP"],"example":"ACTIVE"}}},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"ticket_whitelist_setup","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function adds cPanel Support's IP addresses to your server's firewall\nwhitelist. This function is firewall-specific and does **not** change the\n[cPHulk](https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/)\nwhitelist.\n\n**Note:**\n\n* This function is **not** available through the command line. You **must** call it as\na request body.\n* This function logs error messages to the\n[`/usr/local/cpanel/logs/error_log`](https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#usr-local-cpanel-logs-error-log)\nfile.","operationId":"ticket_whitelist_setup","parameters":[],"summary":"Add Support IP addresses to firewall","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_whitelist_setup?api.version=1"}],"tags":["Support Tickets","Support Access"]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"}},"myprivs":{"paths":{"/myprivs":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"type":"string","description":"The method name called.","example":"myprivs"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"type":"object","properties":{"privileges":{"description":"An array of objects that contains the privileges available to the user, including any third-party ACL privileges.","items":{"properties":{"ssl":{"description":"Allows the user to manage the SSL certificates installed on domains.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"basic-whm-functions":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether to give the reseller access to basic cPanel & WHM options.\n* `1` — Enabled.\n* `0` — Disabled."},"edit-pkg":{"description":"Allows the user to create and delete packages.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"news":{"type":"integer","description":"Allows the user to send news messages to customers' accounts.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0"},"manage-oidc":{"description":"Allows the user to manage external authentication for their accounts.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"manage-dns-records":{"description":"Allows the user to manage DNS records.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"ssl-gencrt":{"example":"0","enum":["0","1"],"description":"Allows the user to use the SSL CSR/CRT generator.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"mailcheck":{"type":"integer","example":"0","enum":["0","1"],"description":"Allows the user to access WHM's [_Mail Troubleshooter_](https://go.cpanel.net/whmdocsMailTroubleshooter) interface (_WHM >> Home >> Mail >> Mail Troubleshooter_).\n* `1` — Enabled.\n* `0` — Disabled."},"create-acct":{"type":"integer","enum":["0","1"],"example":"0","description":"Allows the user to create accounts.\n* `1` — Enabled.\n* `0` — Disabled."},"manage-styles":{"type":"integer","enum":["0","1"],"example":"0","description":"Allows the user to manage their server's cPanel styles.\n* `1` — Enabled.\n* `0` — Disabled."},"file-restore":{"type":"integer","example":"0","enum":["0","1"],"description":"Allows the user to restore specific files and directories from a backup.\n* `1` — Enabled.\n* `0` — Disabled."},"allow-addoncreate":{"description":"Allows the user to create packages with addon domains.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"edit-account":{"type":"integer","description":"Allows the user to modify accounts.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Warning:**\n\nThis privilege allows circumvention of account creation limits, gives shell access unless explicitly disallowed, and provides access to dedicated IP addresses, among other features.","enum":["0","1"],"example":"0"},"status":{"type":"integer","enum":["0","1"],"example":"0","description":"Allows the user to view WHM's [_Service Status_](https://go.cpanel.net/whmdocsServiceStatus) interface (_WHM >> Home >> Server Status >> Service Status_).\n* `1` — Enabled.\n* `0` — Disabled."},"edit-dns":{"enum":["0","1"],"example":"0","description":"Allows the user to edit DNS zones.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"manage-api-tokens":{"example":"0","enum":["0","1"],"description":"Allows the user to manage API tokens.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nThis ACL privilege allows an API token user to bypass any restrictions that you set on the API token.","type":"integer"},"add-pkg-ip":{"description":"Allows the user to create packages with dedicated IP addresses.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"acct-summary":{"description":"Allows the user to view an account summary.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0","type":"integer"},"basic-system-info":{"description":"Allows the user to retrieve basic system information.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"list-pkgs":{"description":"Allows the user to view existing hosting plans (packages).\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"viewglobalpackages":{"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.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"]},"quota":{"description":"Allows the user to modify disk space quotas for accounts.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Warning:**\n\n This ACL privilege allows circumvention of account package limits if you do not use resource limits.","example":"0","enum":["0","1"],"type":"integer"},"allow-shell":{"description":"Allows the user to create an account with shell access.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"rearrange-accts":{"type":"integer","example":"0","enum":["0","1"],"description":"Allows the user to rearrange the locations of customer accounts in order to free up disk space.\n* `1` — Enabled.\n* `0` — Disabled."},"stats":{"enum":["0","1"],"example":"0","description":"Allows the user to view WHM's [_Server Information_](https://go.cpanel.net/whmdocsServerInformation) interface (_WHM >> Home >> Server Status >> Server Information_).\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"resftp":{"type":"integer","description":"Allows the user to re-sync FTP account passwords.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"]},"list-accts":{"description":"Allows the user to list owned accounts.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"kill-acct":{"description":"Allows the user to delete their customers' accounts.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0","type":"integer"},"create-user-session":{"example":"0","enum":["0","1"],"description":"Allows the user to create a new temporary user session for a specified service.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nThis 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.","type":"integer"},"park-dns":{"type":"integer","enum":["0","1"],"example":"0","description":"Allows the user to park domains within WHM.\n* `1` — Enabled.\n* `0` — Disabled."},"ns-config":{"type":"integer","description":"Allows the user to manage nameservers.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0"},"generate-email-config":{"enum":["0","1"],"example":"0","description":"Allows the user to generate a mobile configuration profile for an email account.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"ssl-buy":{"description":"Allows the user to use WHM's [_Purchase and Install an SSL Certificate_](https://go.cpanel.net/whmdocsPurchaseandInstallanSSLCertificate) interface (_WHM >> Home >> SSL/TLS >> Purchase and Install an SSL Certificate_).\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0","type":"integer"},"add-pkg":{"type":"integer","enum":["0","1"],"example":"0","description":"Allows the user to create packages.\n* `1` — Enabled.\n* `0` — Disabled."},"passwd":{"example":"0","enum":["0","1"],"description":"Allows the user to modify passwords for customers' accounts.\n* `1` — Enabled.\n* `0` — Disabled.\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.","type":"integer"},"kill-dns":{"type":"integer","description":"Allows the user to delete DNS zones.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0"},"demo-setup":{"enum":["0","1"],"example":"0","description":"Allows the user to enable demo mode on accounts.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"allow-unlimited-pkgs":{"description":"Allows the user to create packages with unlimited values for features (for example, unlimited email accounts).\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0","type":"integer"},"allow-parkedcreate":{"example":"0","enum":["0","1"],"description":"Allows the user to create packages with parked domains (aliases).\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"digest-auth":{"description":"Allows the user to manage Digest Authentication support.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"thirdparty":{"enum":["0","1"],"example":"0","description":"Allows the user to manage third-party service offerings.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"limit-bandwidth":{"type":"integer","description":"Allows the user to modify bandwidth limits on their accounts.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Warning:**\n\n This will allow circumvention of account package limits if you do not use resource limits.","example":"0","enum":["0","1"]},"show-bandwidth":{"enum":["0","1"],"example":"0","description":"Allows the user to view the bandwidth usage of accounts.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"edit-mx":{"type":"integer","description":"Allows the user to edit MX entries.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0"},"allow-emaillimits-pkgs":{"description":"Allows the user to create packages with custom email limits.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"add-pkg-shell":{"example":"0","enum":["0","1"],"description":"Allows the user to create packages with shell access.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"all":{"example":"0","enum":["0","1"],"description":"Provides all access privileges to the user.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Warning:**\n\nIf this value is set to `1` , the user has `root` access.","type":"integer"},"suspend-acct":{"description":"Allows the user to suspend customers' accounts.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0","type":"integer"},"allow-unlimited-disk-pkgs":{"enum":["0","1"],"example":"0","description":"Allows the user to create packages with unlimited disk space quotas.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"cpanel-integration":{"example":"0","enum":["0","1"],"description":"Allows the user to manage how their server and its services connect to other servers and services.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"restart":{"description":"Allows the user to restart services on the server, such as Apache® or Exim.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"],"type":"integer"},"allow-unlimited-bw-pkgs":{"description":"Allows the user to create packages with unlimited bandwidth.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0","type":"integer"},"clustering":{"example":"0","enum":["0","1"],"description":"Allows the user to configure DNS clusters.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"ssl-info":{"type":"integer","enum":["0","1"],"example":"0","description":"Allows the user to view their server's SSL information.\n* `1` — Enabled.\n* `0` — Disabled."},"cpanel-api":{"enum":["0","1"],"example":"0","description":"Allows the reseller to execute cPanel [UAPI](https://go.cpanel.net/uapi) functions via WHM.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"create-dns":{"type":"integer","description":"Allows the user to create DNS zones.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"]},"upgrade-account":{"enum":["0","1"],"example":"0","description":"Allows the user to upgrade and downgrade customers' domain accounts.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"mysql-info":{"enum":["0","1"],"example":"0","description":"Allows the user to retrieve MySQL® database and user data.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"locale-edit":{"type":"integer","description":"Allows the user to create and modify locales on the server.\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"]},"cors-proxy-get":{"type":"integer","example":"0","enum":["0","1"],"description":"Allows the user to perform Cross-Origin Resource Sharing (CORS) HTTP requests.\n* `1` — Enabled.\n* `0` — Disabled."},"track-email":{"type":"integer","description":"Allows the user to view reports about email message delivery attempts from their account.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"0"}},"type":"object"}}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[],"description":"This function retrieves the current user's [Access Control List (ACL)](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) privileges.","operationId":"myprivs","summary":"Return cPanel account system privileges","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  myprivs\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/myprivs?api.version=1"}],"tags":["Accounts","Account Management"]}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Accounts module for WHM API 1.","name":"Accounts"},{"description":"Accounts / Account Management","name":"Account Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"generatessl":{"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"paths":{"/generatessl":{"get":{"tags":["SSL","SSL Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  generatessl \\\n  domains='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/generatessl?api.version=1&domains=example.com"}],"x-cpanel-api-version":"WHM API 1","summary":"Create self-signed SSL certificate","description":"This function generates a private key file, a certificate signing request (CSR), and a self-signed SSL certificate.","operationId":"generatessl","parameters":[{"schema":{"type":"string","format":"domain"},"examples":{"multiple":{"value":"domain=example1.com,example2.com,example3.com","summary":"Generate an SSL certificate for multiple domains."},"single":{"summary":"Generate an SSL certificate for a single domain.","value":"example.com"}},"description":"A comma-separated list of the certificate's domains.","required":"true","name":"domains","in":"query"},{"name":"countryName","in":"query","required":"false","description":"The certificate's country code.\n\nIf you do not use this parameter, your CSR will **not** include this field.","schema":{"format":"ISO-3166-1 (alpha-2)","example":"US","type":"string"}},{"in":"query","name":"stateOrProvinceName","required":"false","description":"The certificate's state or province name.\n\nIf you do not use this parameter, your CSR will **not** include this field.","schema":{"example":"Texas","type":"string"}},{"name":"localityName","in":"query","required":"false","description":"The certificate's city or locality.\n\nIf you do not use this parameter, your CSR will **not** include this field.","schema":{"example":"Houston","type":"string"}},{"required":"false","in":"query","name":"organizationName","schema":{"example":"Example, L.L.C.","type":"string"},"description":"The certificate's organization.\n\nIf you do not use this parameter, your CSR will **not** include this field."},{"required":"false","in":"query","name":"organizationalUnitName","schema":{"type":"string","default":null,"example":"Development","nullable":"true"},"description":"The department of the organization that owns the certificate."},{"required":"false","in":"query","name":"emailAddress","schema":{"type":"string","format":"email","example":"username@example.com"},"description":"The certificate's contact email address.\n\nIf you do not use this parameter, your CSR will **not** include this field."},{"description":"The certificate's passphrase.","schema":{"type":"string","default":null,"example":"123456luggage","nullable":"true"},"name":"pass","in":"query","required":"false"},{"description":"The size of the certificate's key, in bits.\n\nIf you do not use this parameter, your CSR will **not** include this field.","schema":{"type":"integer","minimum":"1","example":"2048"},"in":"query","name":"keysize","required":"false"},{"required":"false","in":"query","name":"skip_certificate","schema":{"type":"integer","enum":["1","0"],"example":"0","default":"0"},"description":"Whether the function will skip certificate generation.\n\n* `1` — Skip certificate generate (do **not** generate a certificate).\n* `0` — Do **not** skip certificate generation (generate a certificate).\n\n**Note:**\n\nThe function will still generate a CSR and key and save both to the user's `SSLStorage`\ndata store."}],"x-cpanel-available-version":"11.32","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cert_id":{"example":"example_com_a2459_9d253_1405012775_521f3620ac92180d24a74813a921b23e","description":"The certificate's ID.","type":"string"},"certfile":{"example":"/var/cpanel/ssl/system/certs/example_com_e0054_da789_1405012513_401c27501f5e0dd8d1b1d9caa902a0c8.crt","format":"path","description":"The absolute file path to the certificate's location.","type":"string"},"csrfile":{"type":"string","description":"The absolute file path to the CSR.","format":"path","example":"/var/cpanel/ssl/system/csrs/example_com_a2459_9d253_d5edb563abb8dd426099bbb358c8f2bc.csr"},"keyfile":{"type":"string","format":"path","description":"The absolute file path to the private key.","example":"/var/cpanel/ssl/system/keys/e0054_da789_101721a053024156a34e0df8a9c388d4.key"},"sender":{"type":"string","description":"The username that generated the request.","example":"admin"},"csr":{"type":"string","format":"base64 certificate","description":"The CSR's text.","example":"-----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"},"csr_id":{"type":"string","example":"example_com_e0054_da789_96b6625681492b7c43844b6ec37764de","description":"The CSR's ID."},"cert":{"description":"The certificate's text.","format":"base64 certificate","example":"-----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","type":"string"},"sender_host":{"format":"domain","description":"The host that generated the request.","example":"hostname.example.com","type":"string"},"key":{"type":"string","format":"base64 certificate","description":"The private key's text.","example":"-----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"},"key_id":{"type":"string","example":"e0054_da789_101721a053024156a34e0df8a9c388d4","description":"The private key's ID."}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"generatessl"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Key, Certificate, and CSR generated OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["SSL Server Settings"],"name":"SSL Certificates"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / SSL Server Settings","name":"SSL Server Settings"}]},"_getpkgextensionform":{"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/_getpkgextensionform":{"get":{"parameters":[{"name":"pkg","in":"query","required":"true","description":"The hosting plan's name.","schema":{"type":"string","example":"package1"}}],"operationId":"_getpkgextensionform","description":"This function retrieves a hosting plan's package extension templates. When you call this\nfunction, the system checks the hosting plan's `_PACKAGE_EXTENSIONS` value.  The function\nreturns the contents of the `/var/cpanel/packages/extensions/name.tt2` file for each package\nextension in the list, where name represents the package extension's name.\n\nFor more information, read our\n[Guide to Package Extensions](https://go.cpanel.net/GuidetoPackageExtensions).\n\n**Note:**\n\nThis function returns only metadata if the hosting plan does not use package extensions, or\nif the extensions' template files are empty.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"html":{"type":"string","description":"The HTML and Template Toolkit soure code for the hosting plan's extensions' templates.","example":"<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>"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"_getpkgextensionform","description":"The method name called.","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.40","tags":["Packages","Hosting Plan Extensions"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  _getpkgextensionform \\\n  pkg='package1'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/_getpkgextensionform?api.version=1&pkg=package1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return hosting plan extension templates"}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Hosting Plan Extensions"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"description":"Hosting Plans / Hosting Plan Extensions","name":"Hosting Plan Extensions"}]},"restore_queue_clear_all_tasks":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"description":"Account Restoration / Restore Queue Management","name":"Restore Queue Management"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Restore Queue Management"],"name":"Account Restoration"}],"paths":{"/restore_queue_clear_all_tasks":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"restore_queue_clear_all_tasks"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"}}}},"type":"object"}}}}},"description":"This function removes all tasks from the restoration queue.","operationId":"restore_queue_clear_all_tasks","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Remove all restoration tasks","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_clear_all_tasks\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_tasks?api.version=1","lang":"HTTP","label":"URL"}]}}}},"backup_does_client_id_have_google_credentials":{"x-tagGroups":[{"name":"Backups","tags":["Backup Destination"]}],"paths":{"/backup_does_client_id_have_google_credentials":{"get":{"x-cpanel-available-version":"68","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"backup_does_client_id_have_google_credentials","description":"The method name called."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"exists":{"type":"integer","example":"1","enum":["0","1"],"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."}},"type":"object"}},"type":"object"}}}}},"operationId":"backup_does_client_id_have_google_credentials","description":"This function returns whether a Google Drive™ client ID credential file exists.","parameters":[{"required":"true","name":"client_id","in":"query","schema":{"example":"aBcdeFgHIjK123","type":"string"},"description":"The user's Google Drive client ID."}],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_does_client_id_have_google_credentials?api.version=1&client_id=aBcdeFgHIjK123","label":"URL","lang":"HTTP"}]}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup Destination","name":"Backup Destination"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2"},"delete_domain":{"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/delete_domain":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  delete_domain \\\n  domain='example.com'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_domain?api.version=1&domain=example.com"}],"tags":["DNS","Domain Management"],"summary":"Delete domain","x-cpanel-api-version":"WHM API 1","parameters":[{"description":"The name of the domain to delete.","schema":{"type":"string","format":"domain","example":"example.com"},"name":"domain","in":"query","required":"true"}],"description":"This function deletes a domain.\n\n**Note:**\n\nThis function does **not** remove an addon domain's associated subdomain. You **must** also run this function for the associated subdomain.","operationId":"delete_domain","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"delete_domain","description":"The method name called."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"example":"OK","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.","type":"string"}}},"data":{"properties":{"username":{"type":"string","description":"The cPanel user that owned the domain.\n* A cPanel account username.\n* `null` — The function did **not** find a cPanel account that owns the given domain.","format":"domain","example":"username"},"type":{"type":"string","description":"The type of domain that the function deleted.\n* `addon` — An addon domain.\n* `parked` — A parked (alias) domain.\n* `sub` — A subdomain.\n* `null` — The domain does not exist on the server.","example":"addon","enum":["addon","parked","sub"],"nullable":"true"}},"type":"object"}}}}}}},"x-cpanel-available-version":"86"}}},"x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / Domain Management","name":"Domain Management"}]},"create_subdomain":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/create_subdomain":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"create_subdomain"}}},"data":{"type":"object","properties":{"username":{"example":"example","description":"The cPanel account username.\n\n**Note:**\n\n This return **only** appears if the function succeeds.","format":"username","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86","parameters":[{"name":"domain","in":"query","required":"true","description":"The subdomain name to create.","schema":{"type":"string","format":"domain","example":"subdomain.example.com"}},{"required":"true","name":"document_root","in":"query","schema":{"example":"public_html/directory_name","type":"string"},"description":"The subdomain's document root within the home directory.\n\n  **Note:**\n\n * An invalid document root path will cause this function to **fail**.\n * If the *Restrict document roots to public_html* value is set to `On` in WHM's [Tweak Settings](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*), this parameter **must** begin with the `public_html/` path. For more information, read the [cpanel.config](https://go.cpanel.net/cpanelconfiginvalid) file documentation."},{"required":"false","name":"use_canonical_name","in":"query","schema":{"type":"integer","example":"0","enum":["0","1"],"default":"0"},"description":"Whether to use a canonical name in the [Apache® configuration for self-referential URLs](https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname).\n\n* `1` — Use the canonical name.\n* `0` — Do **not** use the canonical name."}],"operationId":"create_subdomain","description":"This function creates a subdomain.","summary":"Create subdomain","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  create_subdomain \\\n  domain='subdomain.example.com' \\\n  document_root='public_html/directory_name'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/create_subdomain?api.version=1&domain=subdomain.example.com&document_root=public_html%2fdirectory_name","label":"URL","lang":"HTTP"}],"tags":["DNS","Domain Management"]}}},"x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"description":"DNS / Domain Management","name":"Domain Management"}]},"killpkg":{"x-tagGroups":[{"name":"Hosting Plans","tags":["Hosting Plans"]}],"paths":{"/killpkg":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","description":"The method name called.","example":"killpkg"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"required":"true","in":"query","name":"pkgname","schema":{"type":"string","example":"package1"},"description":"The hosting plan's name.\n\n**Note:**\n\n You **cannot** delete a hosting plan that a cPanel account currently uses."}],"operationId":"killpkg","description":"This function deletes a hosting plan (package).","x-cpanel-api-version":"WHM API 1","summary":"Delete hosting plan","tags":["Packages","Hosting Plans"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  killpkg \\\n  pkgname='package1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/killpkg?api.version=1&pkgname=package1","label":"URL","lang":"HTTP"}]}}},"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Hosting Plans","description":"Hosting Plans / Hosting Plans"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2"},"get_feature_names":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/get_feature_names":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return all features","tags":["Packages","Feature Lists"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_feature_names\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_feature_names?api.version=1","label":"URL","lang":"HTTP"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"get_feature_names"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"feature":{"type":"array","description":"An array of objects that contain a list of available features.","items":{"type":"object","properties":{"id":{"description":"The feature's ID.","example":"sslmanager","type":"string"},"name":{"type":"string","example":"SSL Manager","description":"The feature's name."}}}}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[],"operationId":"get_feature_names","description":"This function lists all available features."}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Lists"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Hosting Plans / Feature Lists","name":"Feature Lists"}]},"convert_addon_fetch_conversion_details":{"paths":{"/convert_addon_fetch_conversion_details":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return additional domain conversion details","tags":["Domain Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  convert_addon_fetch_conversion_details \\\n  job_id='2'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_fetch_conversion_details?api.version=1&job_id=2"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"job_end_time":{"type":"integer","example":"1462216653","format":"unix_timestamp","description":"A date that indicates when the convertion ended."},"job_id":{"type":"integer","minimum":"1","example":"2","description":"The conversion's job identification number."},"domain":{"description":"The addon domain you converted into a cPanel account.","format":"domain","example":"cptestaddon175.tld","type":"string"},"steps":{"example":[{"status":"DONE","start_time":"1462465001","step_name":"Saving email forwarder data","warnings":"","end_time":"1462465001"},{"end_time":"1462465001","warnings":"","step_name":"Saving custom DNS records","status":"DONE","start_time":"1462465001"},{"step_name":"Saving installed SSL Certificate","end_time":"1462465001","warnings":"","status":"DONE","start_time":"1462465001"},{"step_name":"Saving EasyApache 4 configuration","warnings":"","end_time":"1462465001","start_time":"1462465001","status":"DONE"},{"start_time":"1462465001","status":"DONE","step_name":"Removing Addon Domain","warnings":"","end_time":"1462465009"},{"end_time":"1462465014","warnings":"","step_name":"Creating new cPanel account","start_time":"1462465009","status":"DONE"},{"status":"DONE","start_time":"1462465014","step_name":"Restoring custom DNS records","warnings":"","end_time":"1462465015"},{"end_time":"1462465016","warnings":"","step_name":"Copying Custom VirtualHost Includes","start_time":"1462465015","status":"DONE"},{"end_time":"1462465016","warnings":"/usr/bin/gtar: ./shadow: Cannot open: Permission denied\\n/usr/bin/gtar: Exiting with failure status due to previous errors","step_name":"Copying document root content","status":"DONE","start_time":"1462465016"},{"step_name":"Setting the proper permissions on document root","end_time":"1462465016","warnings":"","start_time":"1462465016","status":"DONE"},{"start_time":"1462465016","status":"DONE","step_name":"Copying email accounts","warnings":"","end_time":"1462465017"},{"status":"DONE","start_time":"1462465017","step_name":"Restoring email forwarders","warnings":"","end_time":"1462465017"},{"start_time":"1462465017","status":"DONE","warnings":"","end_time":"1462465017","step_name":"Copying Autoresponders"},{"step_name":"Copying webmail data","warnings":"","end_time":"1462465017","start_time":"1462465017","status":"DONE"},{"start_time":"1462465017","status":"DONE","warnings":"","end_time":"1462465017","step_name":"Restoring installed SSL Certificate"},{"step_name":"Restoring EasyApache 4 configuration","end_time":"1462465017","warnings":"","status":"DONE","start_time":"1462465017"}],"items":{"type":"object","properties":{"start_time":{"format":"unix_timestamp","description":"The date when the step started.","type":"integer"},"status":{"enum":["DONE","IN PROGRESS","FAILED"],"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.","type":"string"},"step_name":{"type":"string","description":"A step of the conversion process."},"warnings":{"type":"string","description":"The warning message for the step that describes a potential problem, if any exist."},"end_time":{"type":"integer","format":"unix_timestamp","description":"The date when the step ended."}}},"description":"An array of objects containing the steps taken by the conversion process.","type":"array"},"source_acct":{"type":"string","example":"cptest","format":"username","description":"The source cPanel user account that you converted into an account."},"job_status":{"type":"string","example":"DONE","enum":["INPROGRESS","QUEUED","SKIPPED","FAILED","DONE"],"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."},"target_acct":{"example":"user2","description":"The destination cPanel user account for the conversion.","type":"string"},"job_start_time":{"format":"unix_timestamp","description":"A date that indicates when the conversion started.","example":"1462465001","type":"integer"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds."},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"convert_addon_fetch_conversion_details"},"version":{"description":"The API version of the function.","example":"1","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"58","parameters":[{"schema":{"type":"integer","minimum":"1","example":"2"},"description":"The conversion's job identification number.","required":"true","name":"job_id","in":"query"}],"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"}}},"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Accounts / Domain Information","name":"Domain Information"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"get_available_authentication_providers":{"paths":{"/get_available_authentication_providers":{"get":{"description":"This function lists available external authentication identity providers for all services.","operationId":"get_available_authentication_providers","parameters":[],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","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":{"icon":{"type":"string","example":"Click to view...iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=","description":"The icon file to display in the button on the cPanel login interface. A valid Base64-encoded, JPG or PNG-formatted image file."},"id":{"description":"The ID of the identity provider. A valid string.","example":"cpanelid","type":"string"},"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"},"icon_type":{"description":"The icon file's MIME type. A valid image format's MIME type.","example":"image/svg+xml","type":"string"},"textcolor":{"type":"string","example":"FFFFFF","description":"The color of the text label on the cPanel login interface. A valid RGB hexadecimal color value."},"display_name":{"example":"cPanel","description":"The display name of the identity provider. A valid string.","type":"string"},"documentation_url":{"description":"The URL to the identity provider's documentation. A valid URL.","example":"https://go.cpanel.net/cpanelidmanage","type":"string"},"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.","example":"1","enum":["0","1"],"type":"integer"},"cpaneld_link":{"type":"string","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"},"color":{"example":"dd4b39","description":"The background color of the button on the cPanel interface. A valid RGB hexadecimal color value.","type":"string"},"whostmgr_enabled":{"type":"integer","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.","example":"1","enum":["0","1"]},"webmaild_enabled":{"enum":["0","1"],"example":"1","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.","type":"integer"},"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"},"provider_name":{"type":"string","example":"cpanel","description":"The name of the identity provider. A valid string."},"label":{"example":"Log in with a cPanelID Account","description":"The text label that will appear on the cPanel login interface. A valid string.","type":"string"},"webmaild_link":{"example":"https://hostname.example.com:2096/openid_connect/cpanelid","description":"link to the identity provider's configuration for the webmaild service on the system. A valid URL .","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"get_available_authentication_providers","description":"The method name called.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."}}}}}}},"description":"HTTP Request was successful."}},"tags":["Authentication","External Authentication"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_available_authentication_providers\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_authentication_providers?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return available identity providers"}}},"x-tagGroups":[{"name":"Authentication","tags":["External Authentication"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"External Authentication","description":"Authentication / External Authentication"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"block_incoming_email_from_country":{"x-tagGroups":[{"name":"Mail","tags":["Spam Management"]}],"paths":{"/block_incoming_email_from_country":{"get":{"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":{"single":{"value":"AA","summary":"A single country code."},"multiple":{"summary":"Multiple country codes.","value":"country_code-1=AA country_code-2=AB country_code-3=AC"}},"schema":{"type":"string"},"name":"country_code","in":"query","required":"true"}],"operationId":"block_incoming_email_from_country","description":"This function blocks email from specific countries.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated":{"example":"1","enum":["0","1"],"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.","type":"integer"}},"type":"object"},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"example":"block_incoming_email_from_country","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"84","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  block_incoming_email_from_country \\\n  country_code='AA'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/block_incoming_email_from_country?api.version=1&country_code=AA"}],"tags":["Mail","Spam Management"],"summary":"Add block on emails from specific countries","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Spam Management","name":"Spam Management"}],"servers":[{"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."}},"description":"A server running WHM."}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2"},"read_cpgreylist_deferred_entries":{"paths":{"/read_cpgreylist_deferred_entries":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  read_cpgreylist_deferred_entries\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/read_cpgreylist_deferred_entries?api.version=1"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"summary":"Return Greylisting deferred incoming email triplets","x-cpanel-api-version":"WHM API 1","operationId":"cPGreyList-read_cpgreylist_deferred_entries","description":"This function lists Greylisting's deferred triplets.\nGreylisting identifies incoming email by triplets.\n\nA triplet is a collection of three pieces of data:\n* the IP address\n* the sender's address\n* the recipient's address","parameters":[],"x-cpanel-available-version":"11.50","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","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."},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"read_cpgreylist_deferred_entries","description":"The method name called.","type":"string"}}},"data":{"properties":{"greylist_deferred_entries":{"description":"An object of deferred triplet data.","items":{"type":"object","properties":{"deferred_count":{"example":"1","description":"The number of times Greylisting deferred the triplet.","minimum":"0","type":"integer"},"to_addr":{"type":"string","description":"The email address that the system identified as the triplet's recipient.","format":"email","example":"toaddress1.com@example.com"},"block_exp_time":{"example":"2015-03-23T12:09:32.000Z","format":"ISO-8601 Date Time (Space Separated)","description":"The date and time when Greylisting will no longer defer the triplet.","type":"string"},"create_time":{"example":"2015-03-23T11:59:32.000Z","description":"The date and time when Greylisting created the triplet.","format":"ISO-8601 Date Time (Space Separated)","type":"string"},"record_exp_time":{"type":"string","description":"The date and time when Greylisting will purge the triplet from the database.","format":"ISO-8601 Date Time (Space Separated)","example":"2015-03-26T11:59:32.000Z"},"id":{"type":"integer","minimum":"1","description":"The identification number that the system assigned to the triplet.","example":"45"},"must_retry_by":{"example":"2015-03-23T15:59:32.000Z","description":"The date and time when Greylisting will no longer accept the resent triplet.","format":"ISO-8601 Date Time (Space Separated)","type":"string"},"sender_ip":{"type":"string","format":"ipv4","description":"The IP address that the system identified as the triplet's sender.","example":"97.215.255.29"},"accepted_count":{"type":"integer","minimum":"0","description":"The number of times that Greylisting accepted the triplet.","example":"0"},"from_addr":{"type":"string","example":"fromaddress1.com@example.com","format":"email","description":"The email address that the system identified as the triplet's sender."}}},"type":"array"},"offset":{"description":"The number of triplets to skip from the beginning of the query in the interface.","example":"20","type":"integer","minimum":"0"},"total_rows":{"description":"The total number of triplets in the database.","example":"3","type":"integer","minimum":"0"},"server_timezone":{"type":"string","example":"CDT","description":"The standard letter code abbreviation for the time zone."},"limit":{"example":"20","description":"The number of triplets in the interface.","type":"integer","minimum":"0"},"server_tzoffset":{"type":"integer","minimum":"0","description":"The time zone offset in minutes.","example":"60"}},"type":"object"}},"type":"object"}}}}}}}},"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"is_alias_available":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.121.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"name":"cPanel L.L.C.","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"Domain Management","description":"DNS / Domain Management"},{"name":"Resolvers","description":"DNS / Resolvers"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"DNS","tags":["Domain Management"]}],"paths":{"/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","tags":["DNS","Domain Management","Resolvers"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  is_alias_available\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/is_alias_available?api.version=1"}],"x-cpanel-available-version":"cPanel 122","x-cpanel-api-version":"WHM API 1","summary":"Return `ALIAS` DNS record availability & resolver","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"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.","example":"0","enum":["1","0"],"type":"integer"},"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"},"resolver":{"description":"The value (if any) of the running PDNS’s `resolver` setting.","example":"8.8.8.8","type":"string"}}},"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"is_alias_available","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}}},"convert_addon_list_addon_domains":{"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Domain Information","description":"Accounts / Domain Information"}],"paths":{"/convert_addon_list_addon_domains":{"get":{"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"example":{"example.com":{"docroot":"/home/exampleparent/public_html/example.com","subdomain":"example.exampleparent.com","domain_type":"addon","owner":"root","ip":"192.0.2.0"}},"type":"object","additionalProperties":{"properties":{"docroot":{"description":"The document root for the addon domain.","example":"/home/exampleparent/public_html/example.com","type":"string"},"ipv6":{"example":"2001:db8:a0b:12f0::1","format":"ipv6","description":"The domain's IPv6 address.","type":"string"},"subdomain":{"type":"string","example":"example.exampleparent.com","format":"domain","description":"The domain's subdomain."},"reseller":{"example":"exampleparent","description":"The domain's reseller.","format":"username","type":"string"},"domain_type":{"type":"string","description":"The domain's type.","example":"addon"},"ip":{"example":"192.0.2.0","description":"The domain's IPv4 address.","format":"ipv4","type":"string"},"owner":{"example":"exampleparent","description":"The domain's owner.","format":"username","type":"string"}},"description":"An object containing the domain's data.\n\n**Note:**\nThe domain's name is the return's name."}},"metadata":{"properties":{"reason":{"type":"string","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"},"result":{"type":"integer","description":"- `1` - Success.\n- `0` - Failed. Check the reason field for more details.","example":"1","enum":["0","1"]},"version":{"example":"1","description":"The API version of the function.","type":"integer"},"command":{"description":"The method name called.","example":"convert_addon_list_addon_domains","type":"string"}}}}}}}}},"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":[],"summary":"Return current user's additional domains","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  convert_addon_list_addon_domains\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_list_addon_domains?api.version=1"}],"tags":["Domain Information"]}}},"x-tagGroups":[{"tags":["Domain Information"],"name":"Accounts"}],"openapi":"3.0.2","info":{"version":"88","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"twofactorauth_enable_policy":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/twofactorauth_enable_policy":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"twofactorauth_enable_policy","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"54","parameters":[],"description":"This function enables the Two-Factor Authentication (2FA) security policy on the server.","operationId":"twofactorauth_enable_policy","summary":"Enable 2FA","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_enable_policy\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_enable_policy?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Authentication","Two-Factor Authentication"]}}},"x-tagGroups":[{"tags":["Two-Factor Authentication"],"name":"Authentication"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"Two-Factor Authentication","description":"Authentication / Two-Factor Authentication"}]},"fetch_transfer_session_log":{"x-tagGroups":[{"tags":["Transfer Monitoring"],"name":"Transfers"}],"paths":{"/fetch_transfer_session_log":{"get":{"description":"This function returns a transfer session's log file.\n\n**Note:**\n\n For more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","operationId":"fetch_transfer_session_log","parameters":[{"description":"The transfer session's ID.","schema":{"example":"vm5docscpanelcopya20140224163412sylG","type":"string"},"in":"query","name":"transfer_session_id","required":"true"},{"in":"query","name":"logfile","required":"true","description":"The log file's name.","schema":{"oneOf":[{"type":"string","enum":["master.log","master.error_log"]},{"type":"string","description":"A valid log file name found in the `master.log` file.","example":"item-TRANSFER_AccountRemoteUser_root"}],"example":"master.log"}}],"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","description":"The method name called.","example":"fetch_transfer_session_log"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"log":{"format":"json","description":"The logfile's contents.","example":"{\"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","type":"string"}}}}}}}}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetch_transfer_session_log \\\n  transfer_session_id='vm5docscpanelcopya20140224163412sylG' \\\n  logfile='master.log'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_transfer_session_log?api.version=1&transfer_session_id=vm5docscpanelcopya20140224163412sylG&logfile=master.log","lang":"HTTP","label":"URL"}],"tags":["Transfers","Transfer Monitoring"],"summary":"Return transfer session's log file","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"description":"Transfers / Transfer Monitoring","name":"Transfer Monitoring"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"unlink_server_node":{"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Nodes","name":"Server Nodes"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Server Administration","tags":["Server Nodes"]}],"paths":{"/unlink_server_node":{"get":{"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"alias":{"type":"string","description":"The name of a linked remote server node.","example":"example"},"username":{"description":"The username required to make API calls to the linked remote server node.","example":"root","type":"string"},"system_settings":{"properties":{},"type":"object","description":"A list of the `worker_capabilities` return's system settings.","example":{"Mail":{"globalspamassassin":"0"}}},"worker_capabilities":{"type":"object","additionalProperties":{"items":{"type":"string"},"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.","type":"object"},"example":{"Mail":{}},"description":"A group of services required for a remote server node to perform a\nspecific task."},"version":{"type":"string","description":"The version of cPanel & WHM installed on the remote server node.","example":"11.86.0.0"},"enabled_services":{"items":{"type":"string","example":"apache_php_fpm"},"description":"A list of services enabled on the linked remote server node.","type":"array"},"tls_verified":{"enum":["0","1"],"example":"1","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.","type":"integer"},"hostname":{"example":"example.com","format":"hostname","description":"The remote server node's hostname.","type":"string"},"last_check":{"format":"unix_timestamp","description":"The last time that the server queried the current status of the remote server.","example":"1556576165","type":"integer"}}},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"unlink_server_node","description":"The method name called."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"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.","schema":{"type":"string","example":"example"},"name":"alias","in":"query","required":"true"},{"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.","schema":{"type":"string","example":"expire_24h","enum":["leave","expire_24h"],"default":"leave"},"in":"query","name":"handle_api_token","required":"false"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove linked server node","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  unlink_server_node \\\n  alias='example'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/unlink_server_node?api.version=1&alias=example","label":"URL","lang":"HTTP"}]}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."}},"modsec_disable_vendor":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Vendor Settings","description":"Web Server Security (ModSecurity) / Rule Vendor Settings"}],"paths":{"/modsec_disable_vendor":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"example":"modsec_disable_vendor","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[{"name":"vendor_id","in":"query","required":"true","description":"The vendor's unique short name.","schema":{"example":"SomeVendor","type":"string"}}],"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","summary":"Disable ModSecurity vendor rules","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_disable_vendor \\\n  vendor_id='SomeVendor'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor?api.version=1&vendor_id=SomeVendor","lang":"HTTP","label":"URL"}],"tags":["ModSecurity","Rule Vendor Settings"]}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"analyze_transfer_session_remote":{"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"name":"Transfer Monitoring","description":"Transfers / Transfer Monitoring"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"tags":["Transfer Monitoring"],"name":"Transfers"}],"paths":{"/analyze_transfer_session_remote":{"get":{"parameters":[{"in":"query","name":"transfer_session_id","required":"true","description":"The transfer session's ID.","schema":{"type":"string","example":"exampleservercopya20140206192428NtyW"}}],"description":"This function checks the remote server's credentials, which a transfer session uses to connect.","operationId":"analyze_transfer_session_remote","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"analyze_transfer_session_remote","description":"The method name called.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  analyze_transfer_session_remote \\\n  transfer_session_id='exampleservercopya20140206192428NtyW'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/analyze_transfer_session_remote?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW"}],"tags":["Transfers","Transfer Monitoring"],"summary":"Validate remote server's credentials","x-cpanel-api-version":"WHM API 1"}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."}},"convert_addon_list_conversions":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"description":"Accounts / Domain Information","name":"Domain Information"}],"paths":{"/convert_addon_list_conversions":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","type":"string"},"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"},"command":{"type":"string","description":"The method name called.","example":"convert_addon_list_conversions"}}},"data":{"type":"object","properties":{"conversions":{"description":"List of conversions from an addon domain to an independent cPanel account.","items":{"type":"object","properties":{"job_id":{"example":"1","description":"The conversion's job number.","minimum":"0","type":"integer"},"end_time":{"example":"1462216653","description":"A date in Unix time format that indicates when the process ended.","format":"unix_timestamp","type":"integer"},"domain":{"example":"example.com","description":"The addon domain to convert into a cPanel account.","format":"domain","type":"string"},"start_time":{"type":"integer","example":"1462216639","format":"unix_timestamp","description":"A date in Unix time format that indicates when the process started."},"source_acct":{"example":"example","description":"The cPanel account username that owned the domain at the time of conversion.","format":"username","type":"string"},"target_acct":{"type":"string","description":"The destination user account for the conversion.","format":"username","example":"example2"},"status":{"example":"DONE","enum":["DONE","IN PROGRESS","FAILED"],"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.","type":"string"}}},"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"58","parameters":[],"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","x-cpanel-api-version":"WHM API 1","summary":"Return additional domains conversion queue","tags":["Domain Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  convert_addon_list_conversions\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_list_conversions?api.version=1"}]}}},"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"openapi":"3.0.2","info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"get_database_optimizations":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Databases","tags":["MySQL Databases"]}],"paths":{"/get_database_optimizations":{"get":{"summary":"Return MySQL database optimizations","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_database_optimizations\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_database_optimizations?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Databases","MySQL Databases"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"get_database_optimizations","description":"The method name called.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}},"data":{"type":"object","properties":{"payload":{"items":{"properties":{"value":{"type":"string","example":"2M","description":"The recommended option value."},"reason":{"example":"Your system's peak theoretical memory allocation is too high and may cause instability.","description":"A justification for why the option should be adjusted.","type":"string"},"name":{"type":"string","example":"innodb_sort_buffer_size","description":"The name of the option."}},"type":"object"},"description":"An array of objects that contain my.cnf options and their recommended values.","type":"array"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[],"operationId":"get_database_optimizations","description":"This function retrieves available database optimizations.\n\n**Warning:**\n\nOn some servers, this function may return 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\nThe system **disables** this function when you have **not** configured remote MySQL, and you've disabled the MySQL/MariaDB and PostgreSQL [roles](https://go.cpanel.net/serverroles)."}}},"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"MySQL Databases","description":"Databases / MySQL Databases"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}]},"eol_php_sites":{"openapi":"3.0.2","info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"EasyApache","description":"The EasyApache module for WHM API 1."},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"}],"paths":{"/eol_php_sites":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"example":"eol_php_sites","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"eol_php_sites":{"type":"integer","description":"The count of domains using PHP versions older than the oldest supported version.","example":"42"}}}},"type":"object"}}}}},"x-cpanel-available-version":"136","parameters":[],"description":"This function counts the number of domains across all cPanel users that are using\nend-of-life (EOL) PHP versions. It determines EOL status by comparing each domain's\nPHP version against the `oldest_supported_version` value from the\n`/etc/cpanel/ea4/ea4-metainfo.json` file.","operationId":"EolPHPSites_eol_php_sites","summary":"Count domains using EOL PHP versions","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  eol_php_sites\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/eol_php_sites?api.version=1","label":"URL","lang":"HTTP"}],"tags":["EasyApache","EasyApache Settings"]}}},"x-tagGroups":[{"tags":["EasyApache Settings"],"name":"Web Server Configuration"}]},"get_service_config_key":{"paths":{"/get_service_config_key":{"get":{"summary":"Return service configuration key","x-cpanel-api-version":"WHM API 1","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"}],"tags":["Server Administration","Services"],"x-cpanel-available-version":"58","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"type":"string","example":"get_service_config_key","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"properties":{"mail_process_size":{},"key name":{"type":"string","example":"512","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."}},"type":"object"}}}}}}},"operationId":"get_service_config_key","description":"This function returns a specific configuration key for a service.","parameters":[{"schema":{"type":"string","example":"dovecot"},"description":"The service's name.","required":"true","in":"query","name":"service"},{"description":"The configuration key's name.","schema":{"example":"mail_process_size","type":"string"},"name":"key","in":"query","required":"true"}]}}},"x-tagGroups":[{"tags":["Services"],"name":"Server Administration"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Services","name":"Services"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"list_integration_groups":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"name":"Integration","description":"The Integration module for WHM API 1."},{"description":"Integrations / Links","name":"Links"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Links"],"name":"Integrations"}],"paths":{"/list_integration_groups":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return integration link groups","tags":["Integration","Links"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_integration_groups \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_integration_groups?api.version=1&user=username","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"list_integration_groups","description":"The method name called."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"links":{"description":"An array of objects that contain the integration link groups.","items":{"type":"object","properties":{"group":{"type":"string","description":"The group ID.","example":"Group3"}}},"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"list_integration_groups","description":"This function lists the groups of integration links in the cPanel interface.","parameters":[{"description":"The cPanel account name.","schema":{"example":"username","type":"string"},"in":"query","name":"user","required":"true"}]}}}},"validate_current_dmarcs":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API","version":"11.123.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"paths":{"/validate_current_dmarcs":{"get":{"operationId":"EmailAuth::validate_current_dmarcs","description":"This function retrieves and checks the DMARC record for one or more domains.","parameters":[{"in":"query","name":"domain","required":"false","examples":{"multiple":{"value":"domain-1=example.com&domain-2=example.com&domain-3=example3.com","summary":"Check the DMARC record for multiple domains."},"multiple-alternative":{"value":"domain=example.com&domain=example2.com&domain=example3.com","summary":"Check the DMARC record for multiple domains."},"single":{"value":"domain=example.com","summary":"Check the DMARC records for a single domain."}},"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.","schema":{"type":"string"}}],"x-cpanel-available-version":"124","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payload":{"example":[{"state":"VALID","record":"v=DMARC1; p=none;","suggested":"v=DMARC1; p=none;","domain":"example.com","subdomain":"_dmarc.example.com","error":""},{"domain":"example2.com","subdomain":"_dmarc.example2.com","error":"(XID 4krw35) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “_dmarc.example2.com”’s “TXT” records.","state":"DNS_ERROR","record":"","suggested":"v=DMARC1; p=none;"}],"description":"An array of objects containing information about the domain's DMARC records.","items":{"properties":{"record":{"type":"string","description":"The domain's DMARC TXT record.","example":"v=DMARC1; p=none;"},"state":{"example":"VALID","enum":["VALID","MALFORMED","DKIM_SPF_ERROR","DKIM_ERROR","SPF_ERROR","MISSING","DNS_ERROR"],"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.","type":"string"},"suggested":{"description":"The recommended DMARC policy.","example":"v=DMARC1; p=none;","type":"string"},"subdomain":{"format":"domain","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","type":"string"},"domain":{"format":"domain","description":"The target domain of the DMARC policy.","example":"example.com","type":"string"},"error":{"type":"string","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":"object"}}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"example":"validate_current_dmarcs","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"}}}}}}}}},"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Mail","Mail DNS Settings"],"summary":"Validate DMARC records","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["Mail DNS Settings"]}]},"get_server_node_status":{"x-tagGroups":[{"name":"Server Administration","tags":["Server Nodes"]}],"paths":{"/get_server_node_status":{"get":{"x-cpanel-available-version":"86","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"system_settings":{"example":{"Mail":{"globalspamassassin":"1"}},"description":"An object containing the remote server's child node system settings.","type":"object"},"tls_verified":{"example":"1","enum":["0","1"],"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.","type":"integer"},"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":{"worker_capabilities":{"Mail":{}},"version":"11.90.0.0","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"],"alias":"MailNode","system_settings":{"Mail":{"globalspamassassin":"1"}},"username":"root","tls_verified":"0","last_check":"1583934071","hostname":"mailnode.example.com"},"type":"object"},"type":"array"},"version":{"example":"11.90.0.0","description":"The installed version of cPanel & WHM on the remote server node.","type":"string"},"enabled_services":{"items":{"example":"apache_php_fpm","type":"string"},"description":"An list of the remote server node's enabled services.","type":"array"}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"get_server_node_status","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"operationId":"get_server_node_status","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.","parameters":[{"name":"api_token","in":"query","required":"true","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.","schema":{"type":"string","example":"23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H"}},{"schema":{"example":"example.com","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.","required":"true","in":"query","name":"hostname"},{"in":"query","name":"username","required":"true","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.","schema":{"type":"string","example":"root"}},{"schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"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.","required":"false","name":"skip_tls_verification","in":"query"}],"x-cpanel-api-version":"WHM API 1","summary":"Return linked server node status","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_server_node_status \\\n  api_token='23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H' \\\n  hostname='example.com' \\\n  username='root'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_server_node_status?api.version=1&api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H&hostname=example.com&username=root"}]}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Nodes","name":"Server Nodes"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"backup_config_get":{"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Settings","description":"Backups / Backup Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"tags":["Backup Settings"],"name":"Backups"}],"paths":{"/backup_config_get":{"get":{"parameters":[],"operationId":"backup_config_get","description":"This function retrieves your backup destination configuration file data.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"example":"backup_config_get","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"backup_config":{"description":"A list of backup configuration data.","type":"object","properties":{"backupenable":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},"backup_daily_enable":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether daily backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},"gziprsyncopts":{"type":"string","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"},"min_free_space":{"example":"1024","description":"The minimum amount of free disk space the system checks for on the destination server before attempting a backup to that server.","minimum":"1","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"},"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"},"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.","example":"0","enum":["0","1"],"type":"integer"},"backup_monthly_retention":{"minimum":"1","type":"integer","description":"The number of retained monthly backups.","example":"5"},"backup_monthly_dates":{"type":"string","example":"1,15,22","description":"A comma-seprated list of the days of the month on which the system runs monthly backups."},"mysqlbackup":{"type":"string","example":"accounts","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."},"force_prune_monthly":{"type":"integer","enum":["0","1"],"example":"0","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."},"maximum_restore_timeout":{"example":"21600","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.","minimum":"1","type":"integer"},"backup_weekly_day":{"type":"string","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"},"backupfiles":{"example":"1","enum":["0","1"],"description":"Whether system file backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","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"},"backup_weekly_retention":{"type":"integer","minimum":"1","description":"The number of retained weekly backups.","example":"4"},"backup_monthly_enable":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether monthly backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},"min_free_space_unit":{"type":"string","enum":["MB","percent"],"example":"MB","description":"The unit of measure of disk space for the `min_free_space` return.\n\n* `MB` — Megabytes.\n* `percent` — Percentages."},"disable_metadata":{"type":"integer","enum":["1","0"],"example":"0","description":"Whether the backup system creates metadata when a backup runs.\n\n* `1` — Disables metadata creation.\n* `0` — Enables metadata creation."},"linkdest":{"enum":["0","1"],"example":"0","description":"Whether the system checks the `rsync` function for hardlink support.\n\n* `1` — Enabled.\n* `0` — Disabled.","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"},"postbackup":{"type":"integer","description":"Whether the `/usr/local/cpanel/scripts/postcpbackup` script runs\nafter the backup completes.\n\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"]},"maximum_timeout":{"type":"integer","minimum":"1","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"},"psqlbackup":{"example":"0","enum":["0","1"],"description":"Whether backups of PostgreSQL® databases are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"backuplogs":{"type":"integer","description":"Whether error log backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","example":"0","enum":["0","1"]},"backupsuspendedaccounts":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether suspended account backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},"backup_daily_retention":{"example":"5","description":"The number of retained daily backups.","minimum":"1","type":"integer"},"errorthreshhold":{"example":"3","description":"The number of times that the system attempts to use the additional backup destination.","type":"integer","minimum":"1"},"backupdir":{"type":"string","description":"The aboslute file path to the server's local backup directory.","example":"/backup"},"backupbwdata":{"type":"integer","description":"Whether bandwidth tracking data backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","example":"1","enum":["0","1"]},"force_prune_daily":{"type":"integer","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.","example":"0","enum":["0","1"]},"backupaccts":{"type":"integer","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"},"check_min_free_space":{"type":"integer","example":"1","enum":["0","1"],"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."},"keeplocal":{"type":"integer","example":"1","enum":["0","1"],"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."},"force_prune_weekly":{"enum":["0","1"],"example":"0","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.","type":"integer"},"backup_weekly_enable":{"type":"integer","description":"Whether weekly backups are enabled.\n\n* `1` — Enable.\n* `0` — Disable.","example":"0","enum":["0","1"]},"backupmount":{"type":"integer","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.","example":"0","enum":["0","1"]}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_config_get\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_config_get?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Backups","Backup Settings"],"summary":"Return backup configuration file data","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"get_provider_client_configurations":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"External Authentication","description":"Authentication / External Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"tags":["External Authentication"],"name":"Authentication"}],"paths":{"/get_provider_client_configurations":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_provider_client_configurations \\\n  service_name='cpaneld' \\\n  provider_id='cpanelid'\n","label":"CLI","lang":"Shell"},{"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"}],"tags":["Authentication","External Authentication"],"summary":"Return identity provider client configuration","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","in":"query","name":"service_name","schema":{"type":"string","example":"cpaneld","enum":["cpaneld","whostmgrd","webmaild"]},"description":"The cPanel & WHM service's name.\n* `cpaneld` — The cPanel daemon.\n* `whostmgrd` — The WHM daemon.\n* `webmaild` — The Webmail daemon."},{"name":"provider_id","in":"query","required":"true","description":"The identity provider's key.","schema":{"type":"string","example":"cpanelid"}}],"description":"This function retrieves the configuration details for the client of an external authentication identity provider.","operationId":"get_provider_client_configurations","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"client_configurations":{"properties":{"client_secret":{"description":"The secret for the client ID.","example":"victoria","type":"string"},"redirect_uris":{"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":{"type":"string","format":"url"},"description":"The redirection URIs for each interface that the identity provider uses.","type":"array"},"client_id":{"example":"1234567890","description":"The client ID for the identity provider.","type":"string"}},"type":"object","description":"An object that contains the client configuration information."}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","example":"get_provider_client_configurations","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"54"}}}},"get_scoped_userdata":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/get_scoped_userdata":{"get":{"description":"This function retrieves all userdata key/value pairs within the specified scope.","operationId":"get_scoped_userdata","parameters":[{"name":"scope","in":"query","required":"true","description":"The scope name whose userdata you wish to retrieve.","schema":{"type":"string","example":"example_scope"}}],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"A mapping of userdata keys to their string values for the given scope.","example":{"items_per_page":"50","theme":"dark"},"type":"object","additionalProperties":{"type":"string"}},"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"get_scoped_userdata"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","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."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["UserData"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_scoped_userdata \\\n  scope='example_scope'"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_scoped_userdata?api.version=1&scope=example_scope","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Get scoped userdata"}}},"x-tagGroups":[{"name":"UserData","tags":["UserData"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"UserData","description":"Scoped userdata storage functions."}]},"unblock_incoming_email_from_country":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Spam Management","description":"Mail / Spam Management"}],"paths":{"/unblock_incoming_email_from_country":{"get":{"operationId":"unblock_incoming_email_from_country","description":"This function unblocks email from specific countries.","parameters":[{"name":"country_code","in":"query","schema":{"type":"string"},"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":{"single":{"description":"To unblock one country code.","value":"US"},"multiple-alternative":{"description":"To unblock multiple country codes using index parameters.","value":"country_code=US&country_code-1=AD&country_code-2=ES"},"multiple":{"description":"To unblock multiple country codes.","value":"country_code=US&country_code=AD"}}}],"x-cpanel-available-version":"84","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"command":{"example":"unblock_incoming_email_from_country","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"}}},"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"}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  unblock_incoming_email_from_country\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/unblock_incoming_email_from_country?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Mail","Spam Management"],"summary":"Remove block on emails from specific countries","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Management"]}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"backup_destination_get":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{"BackupDestinationGetResponseCustom":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"type":"object","properties":{"timeout":{"example":"300","description":"The session timeout, in seconds.","minimum":"30","maximum":"300","type":"integer"},"script":{"example":"/home/backups/beammeupscotty.pl","description":"The absolute file path of the user-supplied transport solution script.","format":"path","type":"string"},"path":{"example":"/backups","description":"The path to the backups directory on the remote server.","format":"path","type":"string"},"username":{"type":"string","example":"username","description":"The remote server account's username."},"host":{"type":"string","format":"domain","description":"The remote server's hostname.","example":"backups.example.com"}}}]},"BackupDestinationGetResponseS3Compatible":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"bucket":{"type":"string","example":"ChockFullOfNuts","description":"The S3-compatible bucket."},"host":{"type":"string","format":"domain","description":"The S3-compatible provider's server.","example":"www.s3example.com"},"timeout":{"description":"The session timeout, in seconds.","example":"300","type":"integer","maximum":"300","minimum":"30"},"folder":{"type":"string","example":"subfolder","description":"The path to the backups directory, relative to the root directory, on the remote server."},"aws_access_key_id":{"example":"s123456789","description":"The S3-compatible provider key ID.","type":"string"}},"type":"object"}]},"BackupDestinationGetResponseRsync":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"host":{"format":"domain","description":"The remote server's hostname.","example":"backups.example.com","type":"string"},"username":{"type":"string","example":"username","description":"The remote server account's username."},"authtype":{"description":"The authorization type.\n* `password`\n* `key`","enum":["password","key"],"example":"password"},"privatekey":{"description":"If the `authtype` return's value is `key`, the absolute path to the private key file.","format":"path","example":"/home/backups/key","type":"string"},"path":{"type":"string","description":"The path to the backups directory on the remote server.","format":"path","example":"/backups"},"timeout":{"example":"300","description":"The session timeout, in seconds.","minimum":"30","maximum":"300","type":"integer"},"port":{"example":"22","description":"The remote server's FTP port.","maximum":"65535","type":"integer","minimum":"1"}},"type":"object"}]},"BackupDestinationGetResponseBase":{"type":"object","properties":{"disable_reason":{"type":"string","description":"An error message that explains why the backup is disabled.\n\n**Note:**\n\nYou will only see this return when the transport is disabled.","example":"Could not list files in destination: example"},"id":{"type":"string","description":"The backup destination's ID","example":"sNnLb1req9oJN9lUJFhA99kY"},"type":{"enum":["Custom","FTP","Local","SFTP","WebDAV","AmazonS3","Rsync","GoogleDrive","S3Compatible","Backblaze"],"example":"Local","description":"The type of backup destination. Select a backup destination from the following menu to view its return values:","type":"string"},"disabled":{"example":"0","enum":["0","1"],"description":"Shows whether the backup destination is disabled.\n* `1` — The destination is disabled.\n* `0` — The destination is enabled.","type":"integer"},"name":{"example":"destination_name","description":"The backup destination's name.","type":"string"}}},"BackupDestinationGetResponseAmazonS3":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"type":"object","properties":{"timeout":{"minimum":"30","type":"integer","maximum":"300","description":"The session timeout, in seconds.","example":"300"},"folder":{"type":"string","example":"subfolder","description":"The path to the backups directory, relative to the root directory, on the remote server.","format":"path"},"bucket":{"description":"The Amazon S3™ bucket.","example":"ChockFullOfNuts","type":"string"},"aws_access_key_id":{"example":"s123456789","description":"The Amazon S3 Access Key ID.","type":"string"}}}]},"BackupDestinationGetResponseGoogleDrive":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"client_id":{"type":"string","example":"aBcdeFgHIjK123","description":"The Google Drive client ID."},"timeout":{"description":"The session timeout, in seconds.","example":"300","minimum":"30","type":"integer","maximum":"300"},"folder":{"description":"The path to the backups directory, relative to the root directory, on the remote server.","format":"path","example":"subfolder","type":"string"},"client_secret":{"example":"aBcde123FgHIjK456","description":"The Google Drive client secret.","type":"string"}},"type":"object"}]},"BackupDestinationGetResponseSFTP":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"port":{"minimum":"1","maximum":"65535","type":"integer","example":"21","description":"The remote server's FTP port."},"timeout":{"example":"300","description":"The session timeout, in seconds.","minimum":"30","maximum":"300","type":"integer"},"path":{"example":"/backups","format":"path","description":"The path to the backups directory on the remote server.","type":"string"},"privatekey":{"example":"/home/backups/key","format":"path","description":"If the `authtype` return's value is `key`, the absolute path to the private key file.","type":"string"},"authtype":{"enum":["password","key"],"example":"password","description":"The authorization type.\n* `password`\n* `key`"},"host":{"type":"string","description":"The remote server's hostname.","format":"domain","example":"backups.example.com"},"username":{"description":"The remote server account's username.","example":"username","type":"string"}},"type":"object"}]},"BackupDestinationGetResponse":{"anyOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseAmazonS3"},{"$ref":"#/components/schemas/BackupDestinationGetResponseBackblaze"},{"$ref":"#/components/schemas/BackupDestinationGetResponseCustom"},{"$ref":"#/components/schemas/BackupDestinationGetResponseFTP"},{"$ref":"#/components/schemas/BackupDestinationGetResponseGoogleDrive"},{"$ref":"#/components/schemas/BackupDestinationGetResponseLocal"},{"$ref":"#/components/schemas/BackupDestinationGetResponseRsync"},{"$ref":"#/components/schemas/BackupDestinationGetResponseS3Compatible"},{"$ref":"#/components/schemas/BackupDestinationGetResponseSFTP"},{"$ref":"#/components/schemas/BackupDestinationGetResponseWebDAV"}],"discriminator":{"mapping":{"S3Compatible":"#/components/schemas/BackupDestinationGetResponseS3Compatible","Custom":"#/components/schemas/BackupDestinationGetResponseCustom","Local":"#/components/schemas/BackupDestinationGetResponseLocal","FTP":"#/components/schemas/BackupDestinationGetResponseFTP","SFTP":"#/components/schemas/BackupDestinationGetResponseSFTP","GoogleDrive":"#/components/schemas/BackupDestinationGetResponseGoogleDrive","Backblaze":"#/components/schemas/BackupDestinationGetResponseBackblaze","WebDAV":"#/components/schemas/BackupDestinationGetResponseWebDAV","Rsync":"#/components/schemas/BackupDestinationGetResponseRsync","AmazonS3":"#/components/schemas/BackupDestinationGetResponseAmazonS3"},"propertyName":"type"}},"BackupDestinationGetResponseFTP":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"username":{"description":"The remote server account's username.","example":"username","type":"string"},"host":{"example":"backups.example.com","description":"The remote server's hostname.","format":"domain","type":"string"},"passive":{"type":"integer","description":"Whether to use passive FTP.\n* `1` - Use passive FTP.\n* `0` - Use active FTP.","example":"1"},"timeout":{"type":"integer","maximum":"300","minimum":"30","description":"The session timeout, in seconds.","example":"300"},"port":{"description":"The remote server's FTP port.","example":"21","minimum":"1","type":"integer","maximum":"65535"},"path":{"description":"The path to the backups directory on the remote server.","format":"path","example":"/backups","type":"string"}},"type":"object"}]},"BackupDestinationGetResponseWebDAV":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"type":"object","properties":{"host":{"format":"domain","description":"The remote server's hostname.","example":"backups.example.com","type":"string"},"username":{"type":"string","example":"username","description":"The remote server account's username."},"ssl":{"type":"integer","description":"Whether to use SSL.\n* `1` - Use SSL.\n* `0` - Do **not** use SSL.","example":"1","enum":["1","0"]},"path":{"type":"string","description":"The path to the backups directory on the remote server.","format":"path","example":"/backups"},"timeout":{"type":"integer","maximum":"300","minimum":"30","description":"The session timeout, in seconds.","example":"300"},"port":{"minimum":"1","type":"integer","maximum":"65535","description":"The remote server's FTP port.","example":"21"}}}]},"BackupDestinationGetResponseLocal":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"no_mount_fail":{"description":"Whether to fail the backup attempt if the mount fails.\n* `1` - Fail the backup attempt.\n* `0` - Do **not** fail the backup attempt.","enum":["1","0"],"example":"0","type":"integer"},"path":{"type":"string","format":"path","description":"The absolute path to the backups directory.","example":"/home/backups"},"mount":{"description":"Whether the path is mounted.\n* `1` - The path is mounted.\n* `0` - The path is **not** mounted.","example":"0","enum":["1","0"],"type":"integer"}},"type":"object"}]},"BackupDestinationGetResponseBackblaze":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationGetResponseBase"},{"properties":{"application_key":{"example":"A123b45CD678e9","description":"The application key's name.","type":"string"},"path":{"format":"path","description":"The path to the backups directory on the remote server.","example":"/backups","type":"string"},"bucket_name":{"example":"ChockFullOfNuts","description":"The bucket's name.","type":"string"},"timeout":{"minimum":"30","type":"integer","maximum":"300","description":"The session timeout, in seconds.","example":"300"},"bucket_id":{"type":"string","description":"The bucket's ID.","example":"a12b34cd5678e9f"},"application_key_id":{"type":"string","example":"12a345B678c9","description":"The application key ID that authenticates the Backblaze B2 account."}},"type":"object"}]}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Backups","tags":["Backup Destination"]}],"paths":{"/backup_destination_get":{"get":{"description":"Use this function to obtain a backup destination's settings.","operationId":"backup_destination_get","parameters":[{"schema":{"type":"string","example":"0W1ei2rd3A4lI5sT6he7Be8st"},"description":"The backup destination's ID.","required":"true","in":"query","name":"id"}],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"examples":{"rsync":{"summary":"type=Rsync","value":{"data":{"port":"22","timeout":"30","id":"xOL7IT7cwJhGYYra09hrPU1r","path":"","name":"rsync","username":"scott_bacula","host":"example.com","upload_system_backup":"0","type":"Rsync","authtype":"password","disabled":"0"},"metadata":{"result":"1","command":"backup_destination_get","version":"1","reason":"OK"}}},"webdav":{"summary":"type=WebDAV","value":{"metadata":{"result":"1","command":"backup_destination_get","version":"1","reason":"OK"},"data":{"type":"WebDAV","disabled":"0","upload_system_backup":"0","username":"scot_bacula","host":"example.com","ssl":"1","timeout":"30","port":"8443","id":"ZlSBGjZEr3HVIqhqsdVgWYOM","path":"","name":"WebDav"}}},"local":{"value":{"metadata":{"version":"1","command":"backup_destination_get","result":"1","reason":"OK"},"data":{"id":"SenJqhJKEEE3rPM4XO7dfBaj","mount":"0","path":"/backup","name":"additional local","upload_system_backup":"0","type":"Local","disabled":"0","no_mount_fail":"0"}},"summary":"type=Local"},"backblaze":{"value":{"data":{"disabled":"0","type":"Backblaze","application_key_id":"appID","upload_system_backup":"0","application_key":"keyS3cret","path":"","name":"BackBlaze","id":"c85HdhrAkpiqumuXylEzrOcb","timeout":"180","bucket_name":"backblaze-bucket-name","bucket_id":"backblaze-bucket-id"},"metadata":{"result":"1","command":"backup_destination_get","version":"1","reason":"OK"}},"summary":"type=BackBlaze"},"amazons3":{"summary":"type=AmazonS3","value":{"data":{"disabled":"0","type":"AmazonS3","bucket":"s3-bucket-brigade","name":"Amazon S3","timeout":"30","id":"Sr1ThYOnnBIXUupTcSBYQywk","folder":"","aws_access_key_id":"access-key-id","upload_system_backup":"0"},"metadata":{"result":"1","command":"backup_destination_get","version":"1","reason":"OK"}}},"google":{"value":{"metadata":{"command":"backup_destination_get","version":"1","result":"1","reason":"OK"},"data":{"upload_system_backup":"0","id":"N9jC0iMGNbDwIph7m0MfkDd4","timeout":"30","client_secret":"backups3crets","folder":"","name":"Googlyness","client_id":"CientID","type":"GoogleDrive","disabled":"0"}},"summary":"type=GoogleDrive"},"sftp":{"value":{"metadata":{"command":"backup_destination_get","version":"1","result":"1","reason":"OK"},"data":{"name":"SFTPBACKUP","path":"","timeout":"30","port":"22","id":"OD5CeyEbHMEmDe0dqhtO3KYl","host":"example.com","username":"scott_bacula","privatekey":"/root/.ssh/the_rsa","upload_system_backup":"0","disabled":"0","type":"SFTP","authtype":"key"}},"summary":"type=SFTP"},"ftp":{"summary":"type=FTP","value":{"metadata":{"result":"1","command":"backup_destination_get","version":"1","reason":"OK"},"data":{"upload_system_backup":"0","passive":"1","type":"FTP","disabled":"0","port":"21","timeout":"30","id":"YXzdB0ZcPZ8daPvRfobqQh6H","name":"FTP backups","path":"","username":"backup_daemon","host":"example.com"}}},"custom":{"summary":"type=Custom","value":{"data":{"upload_system_backup":"0","path":"","name":"destination unknown","id":"Hhd85FsIxbxsLneBMNw1Dmdp","timeout":"30","script":"/bin/bacula_start","disabled":"0","username":"scott_bacula","host":"example.com","type":"Custom"},"metadata":{"command":"backup_destination_get","version":"1","result":"1","reason":"OK"}}},"s3compatable":{"summary":"type=S3Compatable","value":{"data":{"type":"S3Compatible","disabled":"0","host":"osdc.rcc.example.com","upload_system_backup":"0","aws_access_key_id":"563DFGHCVD","id":"68UUM_lypmgTi9_fEaG9MIvY","timeout":"30","folder":"","bucket":"thepail","name":"s3Compatable"},"metadata":{"result":"1","command":"backup_destination_get","version":"1","reason":"OK"}}}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/BackupDestinationGetResponse"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"backup_destination_get","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["Backups","Backup Destination"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  backup_destination_get \\\n  id='0W1ei2rd3A4lI5sT6he7Be8st'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_get?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st"}],"x-cpanel-api-version":"WHM API 1","summary":"Return a backup destination's settings"}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Destination","description":"Backups / Backup Destination"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"package_manager_submit_actions":{"paths":{"/package_manager_submit_actions":{"get":{"x-cpanel-available-version":"11.52","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"build":{"description":"A valid Process ID (PID).","example":"9717","type":"integer"}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"package_manager_submit_actions","description":"The method name called."}}}}}}}}},"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":[{"schema":{"type":"string"},"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":{"single":{"value":"package1","summary":"Install a single RPM package."},"multiple":{"value":"install=package1 install=package2","summary":"Install multiple RPM packages."}},"required":"false","name":"install","in":"query"},{"required":"false","in":"query","name":"uninstall","schema":{"type":"string"},"examples":{"multiple":{"summary":"Uninstall multiple RPM packages.","value":"uninstall=package3 uninstall=package4 uninstall=package5"},"single":{"value":"package3","summary":"Uninstall a single RPM package."}},"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."},{"in":"query","name":"upgrade","required":"false","examples":{"single":{"summary":"Upgrade a single RPM package.","value":"package6"},"multiple":{"summary":"Upgrade multiple RPM packages.","value":"upgrade=package6 upgrade=package7 upgrade=package8"}},"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.","schema":{"type":"string"}}],"summary":"Start RPM package installation, update, or removal","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_submit_actions\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_submit_actions?api.version=1"}],"tags":["RPM","Install or Uninstall Package"]}}},"x-tagGroups":[{"tags":["Install or Uninstall Package"],"name":"System Package Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"description":"System Package Management / Install or Uninstall Package","name":"Install or Uninstall Package"}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"set_manual_mx_redirects":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Mail DNS Settings","description":"Mail / Mail DNS Settings"}],"paths":{"/set_manual_mx_redirects":{"get":{"summary":"Add manual mail exchanger redirect record","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_manual_mx_redirects \\\n  domain='example.com' \\\n  mx_host='mailhostexample.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_manual_mx_redirects?api.version=1&domain=example.com&mx_host=mailhostexample.com","label":"URL","lang":"HTTP"}],"tags":["Mail","Mail DNS Settings"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"payload":{"type":"object","additionalProperties":{"type":"string","x-additionalPropertiesName":"domain","nullable":"true","description":"The domain’s former MX redirect target, or null if the domain did not have an MX redirect target before.","example":"mailhostexample.com"},"example":{"example.com":"mailhostexample.com","example.org":null},"description":"The former manual MX redirect entry for each domain."}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"set_manual_mx_redirects","description":"The method name called."},"result":{"enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"90","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","example":"example.com"},"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."},{"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.","schema":{"type":"string","example":"mailhostexample.com"},"in":"query","name":"mx_host","required":"true"}],"operationId":"set_manual_mx_redirects","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."}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.91.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"passwd":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"tags":[{"description":"Accounts / Passwords","name":"Passwords"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"tags":["Passwords"],"name":"Accounts"}],"paths":{"/passwd":{"get":{"parameters":[{"schema":{"example":"username","type":"string"},"description":"The account's username.","required":"true","in":"query","name":"user"},{"description":"The account's new password.","schema":{"example":"12345luggage","type":"string"},"in":"query","name":"password","required":"true"},{"required":"false","name":"enabledigest","in":"query","schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether to enable Digest Authentication for the account. If you\ndo **not** specify a value, the account retains its current Digest\nAuthentication setting.\n\n* `1` — Enable.\n* `0` — Disable."},{"description":"Whether to enable Digest Authentication for the account. If you\ndo **not** specify a value, the account retains its current Digest\nAuthentication setting. This is an alias for the `enabledigest` parameter.\n\n* `1` — Enable.\n* `0` — Disable.","schema":{"type":"integer","example":"1","enum":["0","1"]},"in":"query","name":"digestauth","required":"false"},{"in":"query","name":"db_pass_update","required":"false","description":"Whether to also change the account's MySQL® password.\n\n* `1` — Also update the account's MySQL password to match the `password` value.\n* `0` — Do **not** update.","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"1"}}],"operationId":"passwd","description":"This function modifies a cPanel or reseller account's password.\n\n**Note**\n\n* When modifying the root password, this will only update the password for the root system user, but not for the root MySQL user.\n* To update the MySQL root user's password, use set_local_mysql_root_password.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"app":{"description":"The services for which the system changed the password.","items":{"type":"string","example":"ftp"},"type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"passwd","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Password changed for user “username”."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  passwd \\\n  user='username' \\\n  password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/passwd?api.version=1&user=username&password=12345luggage"}],"tags":["Passwords"],"summary":"Update cPanel account password","x-cpanel-api-version":"WHM API 1"}}}},"accept_eula":{"paths":{"/accept_eula":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"accept_eula"},"reason":{"example":"OK","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.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"76","parameters":[],"operationId":"accept_eula","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.","summary":"Save EULA acceptance","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  accept_eula\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/accept_eula?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Updates"]}}},"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"unsuspendacct":{"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Accounts / Suspensions","name":"Suspensions"}],"paths":{"/unsuspendacct":{"get":{"parameters":[{"in":"query","name":"user","required":"true","description":"The account to unsuspend.","schema":{"example":"username","type":"string"}},{"in":"query","name":"retain-service-proxies","required":"false","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.","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]}}],"operationId":"unsuspendacct","description":"This function unsuspends an account.\n\n**Note:**\n\n**Only** the `root` account and `root`-enabled resellers can unsuspend a locked account.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"unsuspendacct","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"11","tags":["Suspensions"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  unsuspendacct \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/unsuspendacct?api.version=1&user=username","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Unsuspend cPanel account"}}},"x-tagGroups":[{"tags":["Suspensions"],"name":"Accounts"}]},"fetch_vhost_ssl_components":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"name":"cPanel Account Settings","description":"SSL Certificates / cPanel Account Settings"}],"paths":{"/fetch_vhost_ssl_components":{"get":{"parameters":[],"operationId":"fetch_vhost_ssl_components","description":"This function lists the components of each SSL certificate on the server's virtual hosts.\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/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`","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"components":{"type":"array","description":"An array of objects containing the certificate information.","items":{"type":"object","properties":{"certificate_id":{"example":"example_com_ecfeb_5c8df_1608653403_1de5d524f287f7ec75531239a2f4a133","description":"The certificate's ID.","type":"string"},"certificate":{"description":"The certificate's text.","example":"-----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-----","type":"string"},"cabundle":{"nullable":"true","description":"The certificate's certificate authority (CA) bundle.","example":null,"type":"string"},"key":{"example":"-----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-----","description":"The certificate's private key.","type":"string"},"cabundle_id":{"example":null,"description":"The ID of the certificate's CA bundle.","nullable":"true","type":"string"},"servername":{"type":"string","description":"The domain or domains that the certificate covers.","format":"domain","example":"example.com"},"key_id":{"description":"The ID of the certificate's key.","example":"ecfeb_5c8df_35927dbac0386ff253c269a9cda4c6f3","type":"string"}}}}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"fetch_vhost_ssl_components"},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.32","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetch_vhost_ssl_components\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_vhost_ssl_components?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return all SSL certificate components on vhost"}}},"x-tagGroups":[{"tags":["cPanel Account Settings"],"name":"SSL Certificates"}]},"modsec_disable_rule":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_disable_rule":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Disable ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_disable_rule \\\n  config='modsec_vendor_configs/example.conf' \\\n  id='1234567890'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_rule?api.version=1&config=modsec_vendor_configs%2fexample.conf&id=1234567890"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"modsec_disable_rule"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.46","parameters":[{"description":"The ModSecurity configuration file, relative to the `/etc/apache2/conf.d` directory.","schema":{"example":"modsec_vendor_configs/example.conf","type":"string"},"name":"config","in":"query","required":"true"},{"required":"true","name":"id","in":"query","schema":{"example":"1234567890","type":"string"},"description":"The ModSecurity rule's ID."}],"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"}}}},"cpsc_update":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.111.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"description":"cPCloud Service related WHM API 1 functions.","name":"cPCloud"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["cPCloud"],"name":"cPCloud"}],"paths":{"/cpsc_update":{"get":{"x-cpanel-available-version":"11.112","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"cpsc_update"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","additionalProperties":{},"description":"A key value hash specific to the service that was removed."}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"cpsc_update","description":"This function updates a current cPCloud service deployment based on the currently set configuration.","parameters":[{"in":"query","name":"service","required":"true","description":"The name of the service to update.","schema":{"type":"string","example":"database"}},{"schema":{"example":"This is an example additional property.","additionalProperties":{"type":"object"},"type":"object"},"description":"Service specific configuration parameters.","required":"false","in":"query","name":"example"}],"x-cpanel-internal-only":"true","summary":"Update the current deployment of a cPCloud Service.","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpsc_update \\\n  service=database \\\n  instances=3 \\\n  routers=1\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_update?api.version=1&service=database&instances=3&routers=2","lang":"HTTP","label":"URL"}],"tags":["cPCloud"]}}}},"start_autossl_check_for_one_user":{"paths":{"/start_autossl_check_for_one_user":{"get":{"operationId":"start_autossl_check_for_one_user","description":"This function performs an AutoSSL certificate check in the background for a cPanel user.","parameters":[{"in":"query","name":"username","required":"true","description":"The cPanel username.","schema":{"example":"example","type":"string"}}],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"start_autossl_check_for_one_user","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"properties":{"pid":{"type":"integer","minimum":"1","example":"12345","description":"The process ID of the script."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  start_autossl_check_for_one_user \\\n  username='example'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/start_autossl_check_for_one_user?api.version=1&username=example","label":"URL","lang":"HTTP"}],"tags":["SSL","Auto-Generated Certificates"],"summary":"Start cPanel account AutoSSL check","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"ipv6_enable_account":{"paths":{"/ipv6_enable_account":{"get":{"operationId":"ipv6_enable_account","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.","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"user1,user2,user3","format":"username"},"description":"A comma-delimited list of account names."},{"in":"query","name":"range","required":"true","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).","schema":{"type":"string","example":"Hosting_IPv6_Block"}}],"x-cpanel-available-version":"11.40","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"ipv6_enable_account","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"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"},"type":"object","description":"List of accounts where IPv6 enable failed."},"fail_cnt":{"type":"integer","minimum":"0","example":"0","description":"The number of accounts that failed to enable IPv6."},"ipv6":{"description":"The IPv6 addresses that the system assigned to each account.","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"},"type":"object"}},"example":{"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"},"fail_cnt":"2","failures":{"brain":"The “brain” account does not exist.","pinky":"The “pinky” account does not exist."}}}}}}}}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ipv6_enable_account \\\n  user='user1,user2,user3' \\\n  range='Hosting_IPv6_Block'\n","label":"CLI","lang":"Shell"},{"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"}],"tags":["IP Addresses","IPv6 Address Settings"],"summary":"Add IPv6 address range to accounts","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv6 Address Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"description":"IP Address Management / IPv6 Address Settings","name":"IPv6 Address Settings"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"package_manager_get_package_info":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"List Package Information","description":"System Package Management / List Package Information"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"System Package Management","tags":["List Package Information"]}],"paths":{"/package_manager_get_package_info":{"get":{"parameters":[{"examples":{"single":{"summary":"View one namespace.","value":"ea"},"multiple":{"value":"ns=ea ns=altea","summary":"View multiple namespaces."}},"description":"An available RPM package namespace.\n\n**Note:**\n\n* `ea` and any from `ea4_get_additional_pkg_prefixes` API call are the **only** possible values.\n* If you use this parameter, you cannot use the `package` parameter.\n* To view more than one namespace, pass the parameter multiple times. For example,\n`ns=ea` and `ns=altea`.","schema":{"type":"string","enum":["ea"]},"in":"query","name":"ns","required":"true"},{"in":"query","name":"package","required":"true","description":"An RPM package name on the system.\n\n**Note:**\n\n* If you use this parameter, you cannot use the `ns` parameter.\n* To view more than one package, pass the parameter multiple times. For example,\n`package=ea-php55` and `package=ea-apr-util`.","examples":{"single":{"summary":"View one package.","value":"ea-php55"},"multiple":{"summary":"View multiple packages.","value":"package=ea-php55 package=ea-apr-util"}},"schema":{"type":"string"}},{"in":"query","name":"disable-excludes","required":"false","description":"Whether the system will disable [yum](https://en.wikipedia.org/wiki/Yum_(software))'s\nexclude behavior.\n\n* `1` — Disable yum's exclude behavior.\n* `0` — Do **not** disable yum's exclude behavior.","schema":{"default":"0","enum":["1","0"],"example":"1","type":"integer"}}],"description":"This function retrieves information about the system's available\nRPM packages.\n\n**Note:**\n\nYou must use **either** the `ns` or the `package` parameters.","operationId":"package_manager_get_package_info","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"command":{"type":"string","example":"package_manager_get_package_info","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"type":"object","properties":{"packages":{"items":{"type":"object","properties":{"architecture":{"type":"string","description":"The required system architecture.","example":"x86_64"},"pkg_group":{"type":"string","description":"The RPM package's group.","example":"System Environment/Libraries"},"more_info_url":{"nullable":"true","description":"The RPM package developer's URL, if available.","format":"url","example":"http://apr.apache.org","type":"string"},"release":{"example":"7.7.1.cpanel","description":"The RPM package's cPanel release number.","type":"string"},"license":{"type":"string","description":"The RPM package's distribution license.","example":"ASL 2.0"},"state":{"example":"updatable","enum":["installed","not_installed","updatable"],"description":"The install state of the RPM package.\n\n* `installed`\n* `not_installed`\n* `updatable`","type":"string"},"package":{"type":"string","example":"ea-apr-util","description":"The RPM package name."},"short_description":{"description":"A short description of the RPM package.","example":"Apache Portable Runtime Utility library","type":"string"},"long_description":{"type":"string","example":"The mission of the Apache Portable Runtime (APR) is to provide a\\nfree library of C data structures and routines.","description":"A detailed description of the RPM package."},"version_installed":{"type":"string","example":"1.6.1-4.4.8.cpanel","description":"The currently installed version of an RPM package."},"version":{"type":"string","description":"The version of the RPM package's software.","example":"1.6.1"},"size":{"description":"The RPM package's size.","example":"214647","minimum":"1","type":"integer"},"version_latest":{"description":"The latest available version of an RPM package.","example":"1.6.1-7.7.1.cpanel","type":"string"},"pkg_dep":{"type":"object","properties":{"requires":{"example":["glibc","libuuid","expat","libdb","ea-apr"],"description":"A list of the RPM package's requirements, if any exist.","items":{"type":"string"},"type":"array"},"conflicts":{"description":"A list of the RPM package's conflicts, if any exist.","items":{"type":"string"},"example":["ea-php55-php-ioncube5"],"type":"array"}},"description":"The RPM package's dependencies and conflicts."},"repo_name":{"description":"The repository where the RPM package resides.","example":"NYI","type":"string"}}},"description":"An array of objects containing information about the RPM packages on the system.","type":"array"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_get_package_info \\\n  ns='ea' \\\n  package='ea-php55'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_get_package_info?api.version=1&ns=ea&package=ea-php55","lang":"HTTP","label":"URL"}],"tags":["RPM","List Package Information"],"summary":"Return available RPM packages information","x-cpanel-api-version":"WHM API 1"}}}},"modsec_get_configs":{"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"paths":{"/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":[],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"configs":{"items":{"type":"object","properties":{"active":{"type":"integer","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.","example":"1","enum":["1","0"]},"vendor_id":{"example":"MyVendor","description":"The vendor's unique short name.","type":"string"},"config":{"description":"The configuration file's location, relative to the `/usr/local/apache/conf` directory.","example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"}}},"description":"An array of objects containing information about ModSecurity configuration files.","type":"array"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"modsec_get_configs"},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_get_configs\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return all ModSecurity configuration files"}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"}},"has_digest_auth":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Accounts module for WHM API 1.","name":"Accounts"},{"name":"Account Management","description":"Accounts / Account Management"}],"paths":{"/has_digest_auth":{"get":{"parameters":[{"description":"The cPanel account username.","schema":{"example":"username","type":"string"},"in":"query","name":"user","required":"true"}],"description":"This function checks whether Digest Authentication is enabled for\na cPanel user. Windows® Vista, Windows® 7, and Windows® 8 require Digest Authentication\nsupport in order to access [Web Disk](https://docs.cpanel.net/cpanel/files/web-disk/) over an unencrypted connection.","operationId":"has_digest_auth","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"digestauth":{"type":"integer","description":"Whether Digest Authentication support is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":["0","1"],"example":"1"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","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."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"has_digest_auth","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.34","tags":["Accounts","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  has_digest_auth \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/has_digest_auth?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","summary":"Validate cPanel account Digest Authentication"}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"openapi":"3.0.2","info":{"version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"get_unique_sender_recipient_count_per_user":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"paths":{"/get_unique_sender_recipient_count_per_user":{"get":{"parameters":[{"schema":{"example":"1550702383","format":"unix_timestamp","type":"integer"},"description":"A start time to query.","required":"true","name":"start_time","in":"query"},{"required":"true","name":"end_time","in":"query","schema":{"example":"1551192100","format":"unix_timestamp","type":"integer"},"description":"An end time to query."}],"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","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"type":"array","description":"An array of objects that contain a count for all system users' unique email recipients.","items":{"type":"object","properties":{"unique_sender_recipient_count":{"minimum":"1","type":"integer","description":"A count of the unique sender-recipient pairs for mail sent during a period of time.","example":"120"},"user":{"type":"string","description":"A system user's username.","example":"username"}}}}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"get_unique_sender_recipient_count_per_user","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"80","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_unique_sender_recipient_count_per_user \\\n  start_time='1550702383' \\\n  end_time='1551192100'\n","lang":"Shell","label":"CLI"},{"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"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Return all cPanel account unique email recipients","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"modsec_batch_settings":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Server Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_batch_settings":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["ModSecurity","Server Settings"],"summary":"Run ModSecurity batch settings","x-cpanel-api-version":"WHM API 1","parameters":[{"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":{"value":"1","summary":"Set or update a single configuration setting, in this case for SecConnEngine."}},"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`.","schema":{"type":"integer","maximum":"9","minimum":"0"},"in":"query","name":"setting_id","required":"true"},{"required":"true","name":"state","in":"query","schema":{"anyOf":[{"type":"string","enum":["On","Off"]},{"type":"string","enum":["On","Off","DetectionOnly"]},{"type":"string","enum":["On","Off","RelevantOnly"]},{"type":"string"},{"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":"remove","required":"false","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":{"single":{"summary":"Remove a single configuration setting requested in the `setting_id`","value":"1"},"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"}},"schema":{"type":"integer","default":"0","example":"0","enum":["1","0"]}}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"modsec_batch_settings"}}},"data":{"type":"object","properties":{"updated_settings":{"type":"array","description":"An array of objects that contains the configuration setting's information.","items":{"type":"object","properties":{"setting_id":{"minimum":"1","type":"integer","example":"1","description":"The setting ID."},"state":{"type":"string","example":"On","description":"The setting's current state, as set by the `state` parameter's input value."},"description":{"type":"string","description":"The setting's description.","example":"define the match limit of the PCRE library."},"radio_options":{"items":{"properties":{"option":{"example":"On","description":"The option.","type":"string"},"name":{"description":"The option's display name.","example":"Log all transactions.","type":"string"}},"type":"object"},"description":"An array of objects that contain the setting's options display information.","type":"array"},"url":{"type":"string","example":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit","description":"The URL of the setting's entry in the ModSecurity reference manual."},"name":{"type":"string","description":"The setting's name.","example":"Audit Log Level"},"default":{"example":"1500","description":"The setting's default value.\n\n**Note:**\n\nThe `modsec2.cpanel.conf` file defines this value.","type":"integer","minimum":"1"},"type":{"type":"string","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"},"directive":{"type":"string","description":"The setting's Apache configuration directive.","example":"SecAuditEngine"},"engine":{"type":"integer","description":"Whether the setting is an engine directive.\n\n* `1` — Engine directive.\n* `0` — Normal directive.","enum":["1","0"],"example":"1"}}}}}}}}}}}},"x-cpanel-available-version":"11.46"}}}},"delete_services_cluster_node":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The ServicesCluster module for WHM API 1.","name":"ServicesCluster"},{"description":"ServicesCluster","name":"ServicesCluster"}],"paths":{"/delete_services_cluster_node":{"get":{"description":"This function removes an external server from the services cluster.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","operationId":"delete_services_cluster_node","x-cpanel-internal-only":"true","parameters":[{"name":"host","in":"query","schema":{"example":"192.168.0.1","oneOf":[{"format":"ipv4","type":"string"},{"format":"hostname","type":"string"}]},"description":"The external server‘s hostname or IP address."}],"x-cpanel-available-version":"11.110","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"delete_services_cluster_node","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_services_cluster_node \\\n  host='node1.example.com' \\\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_services_cluster_node?api.version=1&host=node1.example.com","label":"URL","lang":"HTTP"}],"tags":["ServicesCluster"],"summary":"Delete a node from the services cluster.","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"ServicesCluster","tags":["ServicesCluster"]}]},"get_udp6_sockets":{"x-tagGroups":[{"tags":["Connections"],"name":"Server Administration"}],"paths":{"/get_udp6_sockets":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return UDP IPv6 sockets data","tags":["Server Administration","Connections"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_udp6_sockets\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_udp6_sockets?api.version=1"}],"x-cpanel-available-version":"80","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"get_udp6_sockets","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"properties":{"payload":{"type":"array","description":"An array of objects that contains the status of the system's UDP IPv6 sockets.","items":{"properties":{"inode":{"example":"27171","description":"The inode number the Linux kernel assigned to the socket.","minimum":"1","type":"integer"},"wqueue":{"type":"integer","minimum":"0","example":"45","description":"The number of bytes that the system is waiting to send."},"sport":{"description":"The source port number.","example":"53","minimum":"0","type":"integer","maximum":"65535"},"uid":{"description":"The socket's user ID (UID).","example":"25","type":"integer","minimum":"0"},"rqueue":{"minimum":"0","type":"integer","example":"0","description":"The number of bytes in the socket's read buffer."},"dport":{"minimum":"0","maximum":"65535","type":"integer","example":"443","description":"The source port that the Linux kernel reports for the socket."},"src":{"format":"ipv6","description":"The source IPv6 address.","example":"2001:0db8:0:0:1:0:0:1","type":"string"},"state":{"type":"integer","example":"10","description":"The socket's current state, in the Linux kernel's numeric format."},"dst":{"example":"2001:0db8:0:0:1:0:0:2","format":"ipv6","description":"The destination IPv6 address.","type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"}}}}},"description":"This function returns data about the system's user datagram protocol (UDP) IPv6 sockets.\n\n**Important:**\n\n  This function may perform slower on a CentOS 6 system with a large number of UDP sockets.","operationId":"get_udp6_sockets","parameters":[]}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Connections","description":"Server Administration / Connections"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"modsec_preview_vendor":{"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"paths":{"/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":[{"schema":{"format":"url","example":"https://www.example.com/vendor1rules/meta_vendor1.yaml","type":"string"},"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.","required":"true","in":"query","name":"url"}],"x-cpanel-available-version":"11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"description":{"example":"This is the Vendor1 ModSecurity Core Rule Set.","description":"The vendor's description.","type":"string"},"supported_versions":{"example":["2.9.1","2.9.2","2.9.3"],"description":"A list of the ModSecurity versions that the vendor supports.","items":{"type":"string"},"type":"array"},"report_url":{"format":"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","type":"string"},"installed":{"description":"Whether the vendor is installed.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":["1","0"],"example":"1","type":"integer"},"dist_sha512":{"description":"The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash.","example":"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb","type":"string"},"cpanel_provided":{"enum":["1","0"],"example":"0","description":"Whether WebPros International, LLC provided the vendor.\n\n* `1` — cPanel-provided.\n* `0` — **Not** cPanel-provided.","type":"integer"},"dist_md5":{"example":"307cb5320441ebd712e5581d12100dc9","description":"The download's [MD5](https://en.wikipedia.org/wiki/Md5) checksum value.","type":"string"},"vendor_url":{"type":"string","format":"url","description":"The vendor's website URL.","example":"http://www.example.com"},"name":{"example":"Vendor1 ModSecurity Core Rule Set","description":"The vendor's name.","type":"string"},"installed_from":{"type":"string","example":"https://www.example.com/vendor1rules/meta_vendor1.yaml","format":"url","description":"The vendor's metadata file URL."},"path":{"type":"string","example":"/usr/local/apache/conf/modsec_vendor_configs/vendor1","description":"The absolute path to the directory that contains the vendor's configuration files."},"vendor_id":{"type":"string","example":"vendor1","description":"The vendor's unique short name."},"archive_url":{"type":"string","example":"https://www.example.com/vendor1.zip","format":"url","description":"The URL to the vendor's rule set archive."}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","example":"modsec_preview_vendor","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}}}},"tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_preview_vendor \\\n  url='https://www.example.com/vendor1rules/meta_vendor1.yaml'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","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","summary":"Return ModSecurity vendor rule metadata"}}},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Vendor Settings","description":"Web Server Security (ModSecurity) / Rule Vendor Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2"},"modsec_discard_all_rule_changes":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"}],"paths":{"/modsec_discard_all_rule_changes":{"get":{"parameters":[],"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","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"failed":{"items":{"type":"string","format":"path","example":"modsec_vendor_configs/MyVendor/one.conf"},"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.","type":"array"},"outcomes":{"type":"array","description":"An array of objects containing information about the discarded configuration changes.","items":{"type":"object","properties":{"config":{"type":"string","example":"modsec_vendor_configs/MyVendor/one.conf","description":"The file path to the configuration file.\n\n* EasyApache 4 — A valid path, relative to the `/etc/apache2/conf.d/modsec/` directory."},"exception":{"type":"string","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"},"ok":{"enum":["1","0"],"example":"0","description":"Whether the system successfully discarded the rule change.\n\n* `1` — Success.\n* `0` — Failure.","type":"integer"}}}}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"modsec_discard_all_rule_changes","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_discard_all_rule_changes\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_discard_all_rule_changes?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove all staged ModSecurity rule changes"}}},"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}]},"mass_edit_dns_zone":{"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"DNS Zones","description":"DNS / DNS Zones"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"DNS","tags":["DNS Zones"]}],"paths":{"/mass_edit_dns_zone":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 mass_edit_dns_zone zone='example.com' serial='202001010100' remove=23 add='{\"dname\":\"example\", \"ttl\":14400, \"record_type\":\"A\", \"data\":[\"11.22.33.44\"]}'"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/mass_edit_dns_zone?api.version=1&add=%27%7B%22dname%22%3A%22example%22%2C+%22ttl%22%3A14400%2C+%22record_type%22%3A%22A%22%2C+%22data%22%3A%5B%2211.22.33.44%22%5D%7D%27","label":"URL","lang":"HTTP"}],"tags":["DNS","DNS Zones"],"summary":"Update a DNS zone","x-cpanel-api-version":"WHM API 1","parameters":[{"schema":{"type":"string","example":"example.com"},"description":"The name of one of the user’s DNS zones.","required":"true","name":"zone","in":"query"},{"schema":{"minimum":"0","type":"integer","example":"202001010100"},"description":"The current serial number in the DNS zone’s SOA (Start of Authority)\nrecord. If this value does not match the zone’s current state, the\nrequest fails.","required":"true","in":"query","name":"serial"},{"examples":{"a":{"value":"'{\"dname\":\"example\", \"ttl\":14400, \"record_type\":\"A\", \"data\":[\"11.22.33.44\"]}'","description":"An A record."},"aaaa":{"description":"A TXT record.","value":"'{\"dname\":\"example\", \"ttl\":14400, \"record_type\":\"TXT\", \"data\":[\"string1\", \"string2\"]}'"}},"description":"The records to add to the zone. Each item must be a serialized\nJSON object that contains:\n\n* `dname` — The record’s name.\n* `ttl` — The record’s TTL (Time-To-Live) value.\n* `record_type` — The record’s type. For example, `A` or `TXT`.\n* `data` — An array of strings. The format and number of the\n  strings depend on the `record_type` value.","schema":{"items":{"format":"json","type":"string"},"type":"array"},"explode":"true","in":"query","name":"add","required":"false"},{"required":"false","in":"query","name":"edit","explode":"true","schema":{"type":"array","items":{"format":"json","example":"'{\"line_index\": 9, \"dname\":\"example\", \"ttl\":14400, \"record_type\": \"TXT\", \"data\":[\"string1\", \"string2\"]}'","type":"string"}},"description":"The records to edit in the zone. Each item must be a serialized\nJSON object that contains:\n\n* `line_index` — The line number in the DNS zone where the record starts.\n  This is a 0-based index, so to edit the first line in the file\n  use the `0` value. To edit the second line, give `1`, and so forth.\n* `dname` — The record’s name.\n* `ttl` — The record’s TTL (Time-To-Live) value.\n* `record_type` — The record’s new type. For example, `A` or `TXT`.\n* `data` — An array of strings. The format and number of the\n  strings depend on the `record_type` value."},{"schema":{"type":"array","items":{"example":"22","type":"integer","minimum":"0"}},"explode":"true","description":"The line indexes of records to remove from the zone.","required":"false","name":"remove","in":"query"}],"operationId":"mass_edit_dns_zone","description":"This function updates a given DNS zone. It can add, edit,\nand remove many records in a single call. It also ensures\nthat each record not removed will occupy the same\nnumber of lines after the edit as it did before the edit.\n\n**NOTE:**\n\nYou **cannot** use this function to modify temporary domains.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"new_serial":{"description":"The DNS zone’s SOA record’s new serial number.\nYou can use this to submit later edits if you\ntrack the number of lines each record takes up.","example":"2021031903","minimum":"0","type":"integer"}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"mass_edit_dns_zone","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"96"}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"}},"get_password_strength":{"x-tagGroups":[{"tags":["Passwords"],"name":"Accounts"}],"paths":{"/get_password_strength":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_password_strength \\\n  password='12345luggage'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_password_strength?api.version=1&password=12345luggage","label":"URL","lang":"HTTP"}],"tags":["Passwords"],"summary":"Return password strength","x-cpanel-api-version":"WHM API 1","operationId":"get_password_strength","description":"This function measures the strength of a password.","parameters":[{"required":"true","in":"query","name":"password","schema":{"example":"12345luggage","type":"string"},"description":"The password."}],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_password_strength","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"strength":{"example":"21","description":"The password's strength.","minimum":"0","maximum":"100","type":"integer"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"tags":[{"name":"Passwords","description":"Accounts / Passwords"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"reset_service_ssl_certificate":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / SSL Server Settings","name":"SSL Server Settings"}],"paths":{"/reset_service_ssl_certificate":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Create self-signed SSL certificate for service","tags":["SSL","SSL Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  reset_service_ssl_certificate \\\n  service='cpanel'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/reset_service_ssl_certificate?api.version=1&service=cpanel","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.40","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"service":{"description":"The service that the certificate corresponds to.\n* `ftp` - The `ftp` service.\n* `exim` - The `exim` service.\n* `dovecot` - The `dovecot` service.\n* `cpanel` - The `cpanel` service.","enum":["ftp","exim","dovecot","cpanel"],"example":"ftp","type":"string"},"certificate":{"type":"string","description":"The SSL certificate's contents.","format":"pem-certificate","example":"-----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-----"},"certificate_info":{"properties":{"key_algorithm":{"type":"string","description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","example":"rsaEncryption","enum":["rsaEncryption","id-ecPublicKey"]},"issuer.organizationName":{"type":"string","example":"Writer's Guild of America","description":"The organization that generated the certificate."},"is_self_signed":{"type":"integer","description":"This value indicates whether the certificate is a self-signed certificate.\n* `1` - Certificate is self-signed.\n* `0` - Certificate is **not** self-signed.","example":"1","enum":["0","1"]},"domains":{"type":"array","items":{"type":"string","example":"example.com","format":"domain"},"description":"The domains that correspond to the certificate."},"not_after":{"example":"1398805499","format":"unix_timestamp","description":"When the certificate expires.","type":"integer"},"modulus":{"example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","nullable":"true","type":"string"},"ecdsa_curve_name":{"type":"string","example":null,"enum":["prime256v1","secp384r1"],"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.","nullable":"true"},"modulus_length":{"nullable":"true","description":"The certificate's key's modulus length, in bits.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"2048","type":"integer","minimum":"1"},"not_before":{"type":"integer","example":"1367269499","description":"The certificate's validation date.","format":"unix_timestamp"},"issuer.commonName":{"type":"string","description":"The Common Name of the organization that issued the certificate.","example":"example.com"},"ecdsa_public":{"type":"string","nullable":"true","example":null,"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."},"issuer_text":{"type":"string","example":"commonName\nhostname.example.com\nemailAddress\nssl@hostname.example.com","description":"Information about the issuer."}},"type":"object","description":"Detailed information about the certificate."}}},"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"reset_service_ssl_certificate"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}},"description":"This function regenerates a self-signed SSL certificate and assigns it to a service.","operationId":"reset_service_ssl_certificate","parameters":[{"description":"The service.\n\n* `ftp` - The `ftp` service.\n* `exim` - The `exim` service.\n* `dovecot` - The `dovecot` service.\n* `cpanel` - The `cpanel` service.","schema":{"type":"string","enum":["ftp","exim","dovecot","cpanel"],"example":"cpanel"},"name":"service","in":"query","required":"true"}]}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["SSL Server Settings"]}],"openapi":"3.0.2","info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"quota_enabled":{"paths":{"/quota_enabled":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"quota_enabled","type":"string"},"result":{"type":"integer","description":"* 1 - Success\n* 0 - Failed. Check the reason field for more details.","example":"1","enum":["0","1"]},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"quota_enabled":{"example":"0","enum":["0","1"],"description":"Whether quotas are enabled.\n* 1 - Enabled.\n* 0 - Disabled.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11","parameters":[],"operationId":"quota_enabled","description":"This function checks if quotas are enabled on at least one of a user's /home directory mounts.","x-cpanel-api-version":"WHM API 1","summary":"Validate cPanel account quotas","tags":["Bandwidth and Disk Quotas"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  quota_enabled\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/quota_enabled?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Accounts","tags":["Bandwidth and Disk Quotas"]}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Accounts / Bandwidth and Disk Quotas","name":"Bandwidth and Disk Quotas"}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"uninstall_rpm_plugin":{"x-tagGroups":[{"tags":["Install or Uninstall Package"],"name":"System Package Management"}],"paths":{"/uninstall_rpm_plugin":{"get":{"x-cpanel-available-version":"64","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":{"type":"integer","minimum":"0","example":"1234","description":"The PID of the process that is doing the removal."}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"example":"uninstall_rpm_plugin","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"uninstall_rpm_plugin","description":"This function starts the uninstall process for a plugin. The uninstall process runs as a background process.","parameters":[{"schema":{"type":"string","example":"plugin_name"},"description":"The name of a plugin RPM to uninstall.","required":"true","name":"name","in":"query"}],"summary":"Uninstall WHM plugin RPM package","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  uninstall_rpm_plugin \\\n  name='plugin_name'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/uninstall_rpm_plugin?api.version=1&name=plugin_name","lang":"HTTP","label":"URL"}],"tags":["RPM","Install or Uninstall Package"]}}},"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"Install or Uninstall Package","description":"System Package Management / Install or Uninstall Package"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"modsec_undisable_rule":{"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Settings"]}],"paths":{"/modsec_undisable_rule":{"get":{"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"},{"lang":"HTTP","label":"URL","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","summary":"Enable ModSecurity rule","operationId":"modsec_undisable_rule","description":"This function enables a ModSecurity™ rule.\n\n**Important:**\n\n  When you disable the Web Server role, the system disables this function.","parameters":[{"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"},"description":"The ModSecurity configuration file.","required":"true","in":"query","name":"config"},{"schema":{"example":"1234567890","type":"string"},"description":"The ModSecurity rule's ID.","required":"true","in":"query","name":"id"}],"x-cpanel-available-version":"11.46","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"modsec_undisable_rule","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."}},"rebuild_mail_sni_config":{"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"paths":{"/rebuild_mail_sni_config":{"get":{"summary":"Rebuild mail SNI configuration files","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  rebuild_mail_sni_config\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/rebuild_mail_sni_config?api.version=1"}],"tags":["Mail","Mail Server Settings"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"configs_built":{"description":"list of configuration files that this function rebuilt.\n\n**Note:**\n\n The function only returns this value if you call it as the root user.","items":{"example":"/etc/dovecot/sni.conf","type":"string"},"type":"array"},"success":{"type":"integer","description":"Whether the system rebuilt the configuration files.\n* `1` - The system rebuilt the configuration files.\n* `0` - The system did **not** rebuild the configuration files.","example":"1","enum":["0","1"]}},"type":"object"},"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"rebuild_mail_sni_config"},"reason":{"example":"OK","description":"The `reason` the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.48","parameters":[{"schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to reload the Dovecot service after the system rebuilds the configuration files.\n* `1` - Reload Dovecot.\n* `0` - Do **not** reload Dovecot.","required":"false","name":"reload_dovecot","in":"query"}],"description":"This function rebuilds the mail SNI configuration files.","operationId":"rebuild_mail_sni_config"}}},"x-tagGroups":[{"name":"Mail","tags":["Mail Server Settings"]}]},"ticket_grant":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/ticket_grant":{"get":{"description":"This function installs an SSH key from the\n[cPanel Customer Portal](https://tickets.cpanel.net/).\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call\nit as a request body.","operationId":"ticket_grant","parameters":[{"description":"The support ticket's ID number.","schema":{"type":"integer","minimum":"1","example":"999999999"},"in":"query","name":"ticket_id","required":"true"},{"schema":{"example":"rofh411bv8","type":"string"},"description":"The support ticket's secure ID token.","required":"true","name":"secure_id","in":"query"},{"schema":{"minimum":"1","type":"integer","example":"1"},"description":"The server's support ticket ID number.","required":"true","in":"query","name":"server_num"},{"in":"query","name":"ssh_username","required":"false","description":"The username for incoming SSH connections before they escalate to the `root` user. If you do **not** specify a value, the function retrieves the user from the support ticket.","schema":{"type":"string","example":"username"}}],"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ssh_username":{"description":"The username for incoming SSH connections before they escalate the `root` user.","example":"username","type":"string"},"chain_status":{"type":"string","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"example":"ACTIVE","description":"The status of the\n[`iptables`](https://netfilter.org/projects/iptables/index.html)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate `iptables` whitelist\nentries or they already existed.\n* `INACTIVE` — The `iptables` whitelist entries were successfully\nremoved or were already deleted.\n* `ERR_SETUP` — The system failed to add the `iptables` whitelist\nentries.\n* `ERR_UNSETUP` — The system failed to remove the `iptables` whitelist\nentries.\n* `ERR_UNKNOWN` — An unknown error occurred."},"non_fatals":{"type":"array","items":{"type":"string","enum":["ticket_system_log_entry","audit_log"]},"description":"Any non-fatal errors.\n\n* `ticket_system_log_entry` — The function could not record the grant\noperation in the ticket.\n* `audit_log` — The function could not record the grant operation in the\nlocal audit log.\n\n**Note:**\n\nThe system stores the local audit log in the\n`/var/cpanel/logs/supportauth/audit.log`\nfile.","example":[]},"server_num":{"type":"integer","minimum":"1","description":"The server's ID number.","example":"1"},"host_access_wl_status":{"enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"example":"ACTIVE","description":"The status of the `/etc/hosts.allow` file's whitelist entries.\n\n* `ACTIVE` — The system added the appropriate `/etc/hosts.allow` file whitelist\nentries or they already existed.\n* `INACTIVE` — The `/etc/hosts.allow` file whitelist entries were successfully\nremoved or they were already deleted.\n* `ERR_SETUP` — The system failed to add the `/etc/hosts.allow` file whitelist\nentries.\n* `ERR_UNSETUP` — The system failed to remove the `/etc/hosts.allow` file\nwhitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred. ","type":"string"},"hulk_wl_status":{"example":"ACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"description":"The status of the\n[cPHulk](https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate cPHulk whitelist entries or they\nalready existed.\n* `INACTIVE` — The cPHulk whitelist entries were successfully removed or they\nwere already deleted.\n* `ERR_SETUP` — The system failed to add the cPHulk whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the cPHulk whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.","type":"string"},"server_name":{"example":"example","description":"The server's human-readable description from the\n[cPanel Customer Portal](https://tickets.cpanel.net/).","type":"string"},"auth_status":{"type":"string","example":"AUTHED","description":"The installation status."},"auth_time":{"type":"integer","example":"1477338450","format":"unix_timestamp","description":"When the system authorized access."},"ticket_id":{"minimum":"1","type":"integer","example":"999999999","description":"The support ticket's ID number."},"ticket_status":{"type":"string","description":"The support ticket's status.\n\n* `OPEN`\n* `CLOSED`\n* `UNKNOWN`","example":"OPEN","enum":["OPEN","CLOSED","UNKNOWN"]},"csf_wl_status":{"enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"example":"ACTIVE","description":"The status of the\n[ConfigServer Security & Firewall (CSF)](https://www.configserver.com/)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate CSF whitelist entries or they\nalready existed.\n* `INACTIVE` — The CSF whitelist entries were successfully removed or they\nwere already deleted.\n* `ERR_SETUP` — The system failed to add the CSF whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the CSF whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.\n\n**Note:**\n\nIf CSF does not exist on the server, the function will **not**\ndisplay this return.","type":"string"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"ticket_grant","description":"The method name called.","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["Support Tickets","Support Access"],"x-codeSamples":[{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_grant?api.version=1&ticket_id=999999999&secure_id=rofh411bv8&server_num=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"false","summary":"Create Support SSH key"}}},"x-tagGroups":[{"name":"cPanel Support Tickets","tags":["Support Access"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"name":"Support Access","description":"cPanel Support Tickets / Support Access"}]},"cpanel":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"API Execution","description":"API Development Tools / API Execution"}],"paths":{"/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.","schema":{"example":"user","format":"username","type":"string"},"name":"cpanel_jsonapi_user","in":"query","required":"true"},{"description":"The UAPI module name.\n\n**Important:**\n\nModule names are **case-sensitive**.","schema":{"example":"Email","type":"string"},"in":"query","name":"cpanel_jsonapi_module","required":"true"},{"description":"The UAPI function name.\n\n**Important:**\n\nFunction names are **case-sensitive**.","schema":{"example":"listpopswithdisk","type":"string"},"in":"query","name":"cpanel_jsonapi_func","required":"true"},{"in":"query","name":"cpanel_jsonapi_apiversion","description":"The cPanel API version to use.\n* `1` — Use cPanel API 1.\n* `2` — Use cPanel API 2.\n* `3` — Use UAPI.","schema":{"example":"3","enum":["1","2","3"],"default":"2","type":"integer"}},{"name":"Variable Names and Values","in":"query","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.","schema":{"type":"string"}}],"x-cpanel-available-version":"84","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"example":"1","enum":["0","1"],"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"cpanel"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"description":"Information returned by the cPanel API function passed in `cpanel_jsonapi_module` and `cpanel_jsonapi_func`."}},"type":"object"}}}}},"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","summary":"Run cPanel API or UAPI function"}}},"x-tagGroups":[{"tags":["API Execution"],"name":"API Development Tools"}],"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"leika_get_config":{"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Server Administration / Configurations","name":"Configurations"}],"paths":{"/leika_get_config":{"get":{"parameters":[{"required":"false","in":"query","name":"item","schema":{"type":"string"},"examples":{"cpanel.key1":{"description":"Return the `key1` configuration key for the `cpanel` feature.","value":"cpanel.key1"},"webmail.key3.subkey1":{"value":"webmail.key3.subkey1","description":"Return the nested `key3.subkey1` configuration key for the `webmail` feature."}},"description":"The feature(s) for which to return configuration keys.\n\n**Note:**\n\n* Pass multiple `item` parameters to return multiple features' configuration keys.\n* If an `item` parameter returns an `undefined` key value, the configuration value does not exist or is set to `null`.\n"}],"operationId":"leika_get_config","description":"\nThis function returns a cPanel account's Leika configuration data. Leika is an internal module that cPanel & WHM uses to track access to features.\n\n**Note:**\n\nIf you do not provide an `item` parameter, this returns the **entire** configuration.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"example":{"webmail.key3":"JSON object","cpanel.key1":"enabled"},"description":"An object that contains configuration keys and their values.","additionalProperties":{"type":"string"},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"leika_get_config","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"132","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  leika_get_config \\\n  item=cpanel.key1 \\\n  item=webmail.key3.subkey1\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/leika_get_config?api.version=1&item=key1&item=key2"}],"tags":["Configurations"],"summary":"Return Leika configuration","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Configurations"],"name":"Server Administration"}],"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"remove_dmarc":{"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Mail","tags":["Mail DNS Settings"]}],"paths":{"/remove_dmarc":{"get":{"x-cpanel-available-version":"124","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"remove_dmarc","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"payload":{"type":"array","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":{"type":"string","example":"[REMOVE:TXT@_dmarc.exmaple.com:v=DMARC1; p=reject;]","description":"Information about the removed DMARC record."},"status":{"type":"integer","enum":["0","1"],"example":"1","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."}},"type":"object"}}}}},"type":"object"}}}}},"description":"This function removes the DMARC DNS record from a domain.\n\n**Note:**\n\nYou **cannot** remove DMARC records from temporary domains.","operationId":"EmailAuth::remove_dmarc","parameters":[{"in":"query","name":"domain","required":"false","examples":{"multiple":{"value":"domain=example-1.com domain=example-2.com domain=example-3.com","summary":"To remove multiple domain DMARC records"},"single":{"value":"example.com","summary":"To remove a single domain DMARC record"}},"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.","schema":{"type":"string"}}],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_dmarc?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.123.0.9999"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"ticket_whitelist_check":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Support Tickets","description":"The Support Tickets module for WHM API 1."},{"description":"cPanel Support Tickets / Support Access","name":"Support Access"}],"paths":{"/ticket_whitelist_check":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"ticket_whitelist_check","description":"The method name called.","type":"string"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"properties":{"problem":{"enum":["NO","NEED_SETUP","NEED_UNSETUP"],"example":"NO","description":"message that indicates whether a problem exists with the current status.\n* `NO` — The firewall does not require changes.\n* `NEED_SETUP` — You have granted cPanel Support access, but the system's\nfirewall whitelist does not contain support's IP addresses.\n* `NEED_UNSETUP` — The system detected that **no** cPanel Support access\ngrants exist, but the system's firewall whitelist contains support's IP\naddresses.","type":"string"},"chain_status":{"type":"string","description":"The status of the server's firewall whitelist.\n\n* `ACTIVE` — The whitelist is active.\n* `INACTIVE` — The whitelist is inactive.","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[],"operationId":"ticket_whitelist_check","description":"This function checks whether the server's firewall whitelist correlates\nwith the granted support tickets. You can view granted support tickets in\nWHM's\n[*Grant cPanel Support Access*](https://docs.cpanel.net/whm/support/grant-cpanel-support-access/)\ninterface (*WHM >> Home >> Support >> Grant cPanel Support Access*).\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call it as\na request body.","summary":"Validate Support IP addresses on firewall","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_whitelist_check?api.version=1"}],"tags":["Support Tickets","Support Access"]}}},"x-tagGroups":[{"tags":["Support Access"],"name":"cPanel Support Tickets"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"get_application_contact_event_importance":{"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}],"paths":{"/get_application_contact_event_importance":{"get":{"summary":"Return app's event contact importance setting","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_application_contact_event_importance \\\n  app='Check' \\\n  event='SecurityAdvisorStateChange'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange"}],"tags":["Server Administration","Notifications"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"importance":{"type":"integer","enum":["1","2","3","0"],"example":"0","description":"The importance level at which to send the notification.\n* `1` - High.\n* `2` - Medium.\n* `3` - Low.\n* `0` - Disabled."},"name":{"type":"string","description":"The text version of the importance.\n- `High`\n- `Medium`\n- `Low`\n- `Disabled`","enum":["High","Medium","Low","Disabled"],"example":"Disabled"}},"type":"object"},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"get_application_contact_event_importance","description":"The method name called."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"58","parameters":[{"schema":{"example":"Check","type":"string"},"description":"The application module's name.","required":"true","in":"query","name":"app"},{"required":"true","in":"query","name":"event","schema":{"type":"string","example":"SecurityAdvisorStateChange"},"description":"The event's name."}],"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"}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Notifications","name":"Notifications"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"exim_configuration_check":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/exim_configuration_check":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"message":{"type":"string","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"}}},"metadata":{"properties":{"reason":{"example":"Configuration Update Failed","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"exim_configuration_check"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[],"description":"This function scans the Exim configuration file for errors, and if it finds errors attempts to repair them.","operationId":"exim_configuration_check","summary":"Repair Exim configuration file","x-cpanel-api-version":"WHM API 1","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"}],"tags":["Mail","Mail Server Settings"]}}},"x-tagGroups":[{"tags":["Mail Server Settings"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}]},"removezonerecord":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"paths":{"/removezonerecord":{"get":{"tags":["DNS","DNS Zones"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  removezonerecord \\\n  zone='example.com' \\\n  line='4'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/removezonerecord?api.version=1&zone=example.com&line=4","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Delete DNS zone record","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.\n * You **cannot** use this function to modify temporary domains.","operationId":"removezonerecord","parameters":[{"schema":{"type":"string","example":"example.com","format":"domain"},"description":"The zone record's domain.","required":"true","in":"query","name":"zone"},{"required":"true","in":"query","name":"line","schema":{"example":"4","minimum":"1","type":"integer"},"description":"The DNS zone record file's line number."},{"schema":{"example":"2013122501","type":"string"},"description":"The zone file's serial number.\n\nThis parameter defaults to the zone file's current serial number.","required":"false","in":"query","name":"serialnum"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"removezonerecord","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The 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"}}}}}}}}}}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Zones","name":"DNS Zones"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"list_integration_links":{"paths":{"/list_integration_links":{"get":{"summary":"Return integration links","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  list_integration_links \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_integration_links?api.version=1&user=username","label":"URL","lang":"HTTP"}],"tags":["Integration","Links"],"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"list_integration_links","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"}}},"data":{"type":"object","properties":{"links":{"type":"array","items":{"properties":{"app":{"type":"string","example":"WHMCS_billing","description":"The integration link's app name."}},"type":"object"},"description":"An array of objects that contain information about the integration links."}}}}}}}}},"operationId":"list_integration_links","description":"This function lists integration links in the cPanel interface.","parameters":[{"required":"true","in":"query","name":"user","schema":{"format":"username","example":"username","type":"string"},"description":"The cPanel account name."}]}}},"x-tagGroups":[{"tags":["Links"],"name":"Integrations"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Integration","description":"The Integration module for WHM API 1."},{"description":"Integrations / Links","name":"Links"}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"restore_queue_clear_all_failed_tasks":{"paths":{"/restore_queue_clear_all_failed_tasks":{"get":{"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","summary":"Remove all failed restoration tasks","description":"This function removes any failed tasks from the restoration queue.","operationId":"restore_queue_clear_all_failed_tasks","parameters":[],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"example":"restore_queue_clear_all_failed_tasks","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"name":"Restore Queue Management","description":"Account Restoration / Restore Queue Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"twofactorauth_set_issuer":{"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"}],"paths":{"/twofactorauth_set_issuer":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_set_issuer \\\n  issuer='hostname.example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_set_issuer?api.version=1&issuer=hostname.example.com","lang":"HTTP","label":"URL"}],"tags":["Authentication","Two-Factor Authentication"],"summary":"Update 2FA issuer value","x-cpanel-api-version":"WHM API 1","description":"This function sets the `issuer` value that the system uses to generate the `secret` and `otpurls` values for Two-Factor Authentication on your accounts.","operationId":"twofactorauth_set_issuer","parameters":[{"name":"issuer","in":"query","required":"true","description":"The issuer's name.","schema":{"type":"string","example":"hostname.example.com"}}],"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"twofactorauth_set_issuer","description":"The method name called.","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}}}}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"get_users_authn_linked_accounts":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Authentication / External Authentication","name":"External Authentication"}],"paths":{"/get_users_authn_linked_accounts":{"get":{"operationId":"get_users_authn_linked_accounts","description":"This function lists all accounts that link to available external authentication identity providers.","parameters":[],"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"get_users_authn_linked_accounts","description":"The method name called."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"}}},"data":{"properties":{"username_linked_accounts":{"description":"An array of objects containing user accounts with their linked identity provider accounts.","items":{"properties":{"provider_protocol":{"example":"openid_connect","description":"The identity provider's protocol.","type":"string"},"preferred_username":{"example":"username@example.com","description":"The preferred username of the account on the identity provider that the interface will display.","type":"string"},"provider_id":{"type":"string","example":"cpanelid","description":"The system's internal key for the identity provider."},"username":{"description":"The cPanel account's username.","format":"username","example":"username","type":"string"},"subject_unique_identifier":{"example":"123456789012345678901","description":"The unique identifier for the user at the identity provider.","type":"string"},"link_time":{"description":"When the user linked the account.","format":"unix_timestamp","example":"1443124003","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}}}}}}},"tags":["Authentication","External Authentication"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_users_authn_linked_accounts\n","label":"CLI","lang":"Shell"},{"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","summary":"Return accounts linked to identity providers"}}},"x-tagGroups":[{"tags":["External Authentication"],"name":"Authentication"}]},"package_manager_is_performing_actions":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"name":"List Package Information","description":"System Package Management / List Package Information"}],"paths":{"/package_manager_is_performing_actions":{"get":{"tags":["RPM","List Package Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_is_performing_actions \\\n  build='10053'\n","lang":"Shell","label":"CLI"},{"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","summary":"Return RPM package update status","parameters":[{"in":"query","name":"build","required":"true","description":"The process's build number returned by the WHM API 1 `package_manager_submit_actions` function.","schema":{"example":"10053","type":"integer"}}],"operationId":"package_manager_is_performing_actions","description":"This function checks the activity of the process that you executed in the WHM API 1 `package_manager_submit_actions` function.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"package_manager_is_performing_actions","description":"The method name called."}}},"data":{"type":"object","properties":{"active":{"description":"Whether the process is active.\n\n* `1` — Active.\n* `0` — Inactive.","enum":["1","0"],"example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52"}}},"x-tagGroups":[{"name":"System Package Management","tags":["List Package Information"]}]},"backup_destination_delete":{"x-tagGroups":[{"tags":["Backup Destination"],"name":"Backups"}],"paths":{"/backup_destination_delete":{"get":{"tags":["Backups","Backup Destination"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_destination_delete \\\n  id='11111111'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_delete?api.version=1&id=11111111"}],"x-cpanel-api-version":"WHM API 1","summary":"Delete a backup destination","description":"This function removes a backup destination from the backup configuration file.","operationId":"backup_destination_delete","parameters":[{"description":"The destination's ID.","schema":{"example":"11111111","type":"string"},"in":"query","name":"id","required":"true"}],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"command":{"example":"backup_destination_delete","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup Destination","name":"Backup Destination"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"get_service_proxy_backends":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.93.0.9999"},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Services","name":"Services"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Services"],"name":"Server Administration"}],"paths":{"/get_service_proxy_backends":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_service_proxy_backends \\\n  username='example'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_service_proxy_backends?api.version=1&username=example","lang":"HTTP","label":"URL"}],"tags":["Services"],"summary":"Return a cPanel account’s service proxying setup","x-cpanel-api-version":"WHM API 1","parameters":[{"schema":{"type":"string","example":"example","format":"username"},"description":"The cPanel account's username.","required":"true","name":"username","in":"query"}],"description":"This function reports a cPanel account's\n[service proxying](https://go.cpanel.net/ServiceProxying)\nconfiguration.","operationId":"get_service_proxy_backends","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"command":{"type":"string","description":"The method name called.","example":"get_service_proxy_backends"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"payload":{"type":"array","items":{"properties":{"backend":{"format":"domain","description":"The name of the server to which the system will proxy requests for this service group.","example":"example.com","type":"string"},"service_group":{"type":"string","nullable":"true","description":"The name of the proxying service group, if applicable.\n* null — The account’s general service proxying backend.","example":"Mail"}},"type":"object"},"description":"The account’s service proxying backends."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"94"}}}},"add_override_features_for_user":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"description":"Hosting Plans / Feature Access","name":"Feature Access"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Access"]}],"paths":{"/add_override_features_for_user":{"get":{"summary":"Add cPanel account feature list overrides","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  add_override_features_for_user \\\n  user='username' \\\n  features='{\"backup\":\"1\"}'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/add_override_features_for_user?api.version=1&user=username&features=%7b%22backup%22%3a%221%22%7d","label":"URL","lang":"HTTP"}],"tags":["Packages","Feature Access"],"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"add_override_features_for_user","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}}}},"description":"This function adds feature overrides to a cPanel account.","operationId":"add_override_features_for_user","parameters":[{"in":"query","name":"user","required":"true","description":"The cPanel username.","schema":{"type":"string","example":"username","format":"username"}},{"in":"query","name":"features","required":"true","description":"A JSON-encoded list of features to override and whether to enable or disable them.","content":{"application/json":{"schema":{"example":{"backup":"1"},"type":"object","additionalProperties":{"type":"integer","description":"Whether to enable or disable a feature.\n\n* `1` — Enable.\n* `0` — Disable.\n\n**Note:**\n\nFor a list of available features, use WHM API 1's `get_feature_names` function.","enum":["1","0"]}}}}}]}}}},"batch":{"x-tagGroups":[{"tags":["API Execution"],"name":"API Development Tools"}],"paths":{"/batch":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["API Execution"],"summary":"Run multiple WHM API 1 functions","x-cpanel-api-version":"WHM API 1","description":"This function combines calls for multiple WHM API 1 functions.","operationId":"batch","parameters":[{"schema":{"example":"version","type":"string"},"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`","required":"true","name":"command","in":"query"},{"required":"false","in":"query","name":"abort_on_error","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"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."}],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"batch"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"properties":{"result":{"type":"array","example":[{"data":{"hostname":"example-hosting.com"},"metadata":{"result":"1","command":"gethostname","version":"1","reason":"OK"}},{"metadata":{"reason":"OK","command":"version","version":"1","result":"1"},"data":{"version":"11.88.0.1"}}],"items":{"properties":{"data":{"type":"object","description":"The data returned by the command."},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"version","description":"The method name called."},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"}},"type":"object","description":"The metadata returned by the command."}},"type":"object"},"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."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"tags":[{"name":"API Execution","description":"API Development Tools / API Execution"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"save_cpgreylist_config":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"paths":{"/save_cpgreylist_config":{"get":{"summary":"Update Greylisting settings","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  save_cpgreylist_config\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/save_cpgreylist_config?api.version=1"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"x-cpanel-available-version":"11.50","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"command":{"description":"The method name called.","example":"save_cpgreylist_config","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"cpgreylist_config":{"description":"A list of Greylisting settings.","type":"object","properties":{"spf_bypass":{"description":"Whether emails with SPF bypass Greylisting.\n\n* `1` — Bypass.\n* `0` — Do **not** bypass.","enum":["1","0"],"example":"1","type":"integer"},"max_child_procs":{"example":"5","description":"The maximum amount of child processes.","minimum":"1","type":"integer"},"is_enabled":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether Greylisting is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},"must_try_time_mins":{"maximum":"1440","type":"integer","minimum":"1","example":"240","description":"The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet."},"initial_block_time_mins":{"description":"The number of minutes during which Greylisting defers email from an unknown triplet.","example":"10","type":"integer","maximum":"240","minimum":"1"},"child_timeout_secs":{"type":"integer","minimum":"1","example":"5","description":"The maximum amount of seconds that Greylisting waits for child process to time out."},"is_exim_enabled":{"type":"integer","description":"Whether Exim is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","example":"1","enum":["1","0"]},"record_exp_time_mins":{"maximum":"43200","type":"integer","minimum":"1","example":"4320","description":"The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet."},"purge_interval_mins":{"type":"integer","minimum":"1","description":"The number of minutes before Greylisting deletes the records in the Greylisting database.","example":"60"}}}}}},"type":"object"}}}}},"operationId":"save_cpgreylist_config","description":"This function modifies the server's Greylisting configuration settings.\n\n**Important:**\n\nWhen you call this function, you **must** include at least one of the\nfollowing parameters:\n\n* `spf_bypass`\n* `child_timeout_secs`\n* `record_exp_time_mins`\n* `initial_block_time_mins`\n* `max_child_procs`\n* `purge_interval_mins`\n* `must_try_time_mins`","parameters":[{"schema":{"type":"integer","enum":["1","0"],"example":"1"},"description":"Whether emails with SPF bypass Greylisting.\n\n* `1` — Enabled.\n* `0` — Disabled.","required":"false","in":"query","name":"spf_bypass"},{"description":"The maximum of seconds that Greylisting waits for a child process to timeout.\n\n**Note:**\n\nThis parameter affects the function of the `cPGreyList` daemon. Do **not** change this\nvalue unless it is absolutely necessary.","schema":{"example":"5","type":"integer","minimum":"1"},"in":"query","name":"child_timeout_secs","required":"false"},{"description":"The number of minutes before Greylisting deletes the triplet record and treats a\nre-sent email as coming from a new, unknown triplet. The maximum value for this\nparameter is 30 days (`43200` minutes).","schema":{"example":"4320","maximum":"43200","type":"integer","minimum":"1"},"in":"query","name":"record_exp_time_mins","required":"false"},{"in":"query","name":"initial_block_time_mins","required":"false","description":"The number of minutes during which Greylisting defers email from an unknown triplet. The maximum value for this parameter is four hours (`240` minutes).","schema":{"example":"10","type":"integer","maximum":"240","minimum":"1"}},{"schema":{"example":"5","type":"integer","minimum":"1"},"description":"The maximum number of child processes.\n\n**Notes:**\n\n This parameter affects the function of the `cPGreyList` daemon. Do **not** change this\n value unless it is absolutely necessary.","required":"false","name":"max_child_procs","in":"query"},{"schema":{"example":"60","type":"integer","minimum":"1"},"description":"The number of minutes before Greylisting deletes the records in the Greylisting database.\n\n**Note:**\n\nThis parameter affects the function of the `cPGreyList` daemon. Do **not** change this\nvalue unless it is absolutely necessary.","required":"false","name":"purge_interval_mins","in":"query"},{"name":"must_try_time_mins","in":"query","required":"false","description":"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 (`1440` minutes).","schema":{"example":"240","maximum":"1440","type":"integer","minimum":"1"}}]}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Protection (Greylisting)"]}]},"set_market_provider_commission_id":{"x-tagGroups":[{"name":"cPanel Market","tags":["Provider Management"]}],"paths":{"/set_market_provider_commission_id":{"get":{"x-cpanel-available-version":"56","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"set_market_provider_commission_id"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function sets the contact ID to which a cPanel Market provider will send commission.","operationId":"set_market_provider_commission_id","parameters":[{"schema":{"example":"cPStore","type":"string"},"description":"The cPanel Market provider's name.","required":"true","name":"provider","in":"query"},{"required":"true","name":"commission_id","in":"query","schema":{"type":"string","example":"user@example.com"},"description":"The cPanel Store ID to which to send cPanel Market commissions."}],"summary":"Update Market provider commission contact ID","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_market_provider_commission_id \\\n  provider='cPStore' \\\n  commission_id='user@example.com'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_market_provider_commission_id?api.version=1&provider=cPStore&commission_id=user%40example.com"}],"tags":["Market","Provider Management"]}}},"tags":[{"name":"Market","description":"The Market module for WHM API 1."},{"description":"cPanel Market / Provider Management","name":"Provider Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"available_transfer_modules":{"x-tagGroups":[{"tags":["Transfer Monitoring"],"name":"Transfers"}],"paths":{"/available_transfer_modules":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  available_transfer_modules\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/available_transfer_modules?api.version=1"}],"tags":["Transfers","Transfer Monitoring"],"summary":"Return available transfer modules","x-cpanel-api-version":"WHM API 1","operationId":"available_transfer_modules","description":"This function lists all available transfer modules.\n\n**Note:**\n\n  For more information about how this function works with other functions in the transfer and restore process, read our\n  [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide)\n  documentation.","parameters":[],"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"modules":{"additionalProperties":{"type":"string","pattern":"^[1-9][0-9]*$","description":"The priority of the transfer module.\n\n**Note:**\n\nThe key is the transfer module's name.","example":"6000"},"type":"object","example":{"AccountRemoteUser":"4000","AccountRemoteRoot":"3000","FeatureListRemoteRoot":"1000","AccountLocal":"5000","PackageRemoteRoot":"2000","LegacyAccountBackup":"6000"},"description":"The transfer module's information."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"command":{"example":"available_transfer_modules","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}}}}}}},"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"name":"Transfer Monitoring","description":"Transfers / Transfer Monitoring"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"save_spamd_config":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Spam Management","description":"Mail / Spam Management"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Mail","tags":["Spam Management"]}],"paths":{"/save_spamd_config":{"get":{"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"save_spamd_config"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}},"type":"object"}}}}},"operationId":"save_spamd_config","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.","parameters":[{"explode":"false","schema":{"type":"string","example":"127.0.0.1,192.168.0.1"},"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.","style":"form","required":"false","in":"query","name":"allowedips"},{"required":"false","name":"maxconnperchild","in":"query","schema":{"minimum":"1","type":"integer","example":"200"},"description":"The maximum number of connections that the `spamd` daemon allows per child process."},{"required":"false","in":"query","name":"maxchildren","schema":{"example":"5","type":"integer","minimum":"1"},"description":"The maximum number of children per `spamd` process."},{"schema":{"example":"/var/run/spamd.pid","type":"string"},"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.","required":"false","name":"pidfile","in":"query"},{"schema":{"example":"30","type":"integer","minimum":"0"},"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.","required":"false","name":"timeouttcp","in":"query"},{"name":"timeoutchild","in":"query","required":"false","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.","schema":{"example":"300","minimum":"0","type":"integer"}}],"x-cpanel-api-version":"WHM API 1","summary":"Update Apache SpamAssassin™ configuration","tags":["Mail","Spam Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  save_spamd_config\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/save_spamd_config?api.version=1","label":"URL","lang":"HTTP"}]}}}},"emailtrack_user_stats":{"paths":{"/emailtrack_user_stats":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  emailtrack_user_stats\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_user_stats?api.version=1"}],"tags":["Mail","cPanel Account Mail Management"],"summary":"Return all cPanel accounts email tracking statistics","x-cpanel-api-version":"WHM API 1","parameters":[{"description":"The start time of the search window.","schema":{"default":"0","format":"unix_timestamp","example":"1371552781","type":"integer"},"name":"starttime","in":"query","required":"false"},{"schema":{"type":"integer","format":"unix_timestamp","example":"1471552781"},"description":"The end time of the search window.","required":"false","name":"endtime","in":"query"},{"schema":{"type":"string","enum":["remote","remote-or-faildefer","local"],"example":"remote"},"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`","required":"false","in":"query","name":"deliverytype"},{"required":"false","name":"sender","in":"query","schema":{"example":"username@example.com","format":"email","type":"string"},"description":"The sender's email address. If you do not specify a value, this function returns entries for mail from all senders."}],"description":"This function retrieves email tracking statistics for each user.","operationId":"emailtrack_user_stats","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed: Check the reason field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"emailtrack_user_stats","type":"string"}}},"data":{"type":"object","properties":{"records":{"description":"An array of objects containing the message information.","items":{"properties":{"TOTALSIZE":{"type":"integer","example":"27444","format":"bytes","description":"The total size of messages sent by the server."},"USER":{"description":"The mailbox's owner.","example":"example","type":"string"},"SENDCOUNT":{"type":"integer","minimum":"0","example":"14","description":"The number of sent messages."},"DEFERFAILCOUNT":{"minimum":"0","type":"integer","description":"The number of messages that the system deferred and failed to deliver.","example":"0"},"DEFERCOUNT":{"description":"The number of deferral events.","example":"0","type":"integer","minimum":"0"},"PRIMARY_DOMAIN":{"type":"string","description":"The mailbox account's primary domain.","format":"domain","example":"example.com"},"OWNER":{"type":"string","example":"root","description":"The mailbox's account owner."},"SUCCESSCOUNT":{"minimum":"0","type":"integer","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"},"REACHED_MAXEMAILS":{"enum":["0","1"],"example":"1","description":"Whether the mailbox has reached the maximum number of messages allowed per hour.\n* `1` — Reached.\n* `0` — Has **not** reached.","type":"integer"},"DOMAIN":{"format":"domain","description":"The mailbox's domain.","example":"example.com","type":"string"},"FAILCOUNT":{"example":"0","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.","type":"integer","minimum":"0"},"REACHED_MAXDEFERFAIL":{"type":"integer","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":"object"},"type":"array"}}}}}}}}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"set_user_email_forward_destination":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"paths":{"/set_user_email_forward_destination":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"set_user_email_forward_destination","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.52","parameters":[{"in":"query","name":"user","required":"true","description":"The system account name to forward.","schema":{"type":"string","example":"root"}},{"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.","schema":{"type":"string","example":"user"},"in":"query","name":"forward_to","required":"true"}],"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","summary":"Update cPanel account email forward destination","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_user_email_forward_destination \\\n  user='root' \\\n  forward_to='user'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_user_email_forward_destination?api.version=1&user=root&forward_to=user"}],"tags":["Mail","cPanel Account Mail Management"]}}},"x-tagGroups":[{"tags":["cPanel Account Mail Management"],"name":"Mail"}]},"remote_mysql_create_profile":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"openapi":"3.0.2","x-tagGroups":[{"tags":["Remote MySQL Databases"],"name":"Databases"}],"paths":{"/remote_mysql_create_profile":{"get":{"tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_create_profile \\\n  name='MyProfile' \\\n  mysql_host='192.168.0.1' \\\n  mysql_user='username' \\\n  mysql_pass='12345luggage' \\\n  mysql_port='3306'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_create_profile?api.version=1&name=MyProfile&mysql_host=192.168.0.1&mysql_user=username&mysql_pass=12345luggage&mysql_port=3306"}],"x-cpanel-api-version":"WHM API 1","summary":"Create remote MySQL profile","operationId":"remote_mysql_create_profile","description":"This function creates a profile to access a remote MySQL® server.","parameters":[{"description":"The new profile's name.","schema":{"example":"MyProfile","type":"string"},"name":"name","in":"query","required":"true"},{"required":"true","in":"query","name":"mysql_host","schema":{"example":"192.168.0.1","oneOf":[{"type":"string","format":"ipv4"},{"format":"hostname","type":"string"}]},"description":"The MySQL server's IP address or hostname."},{"schema":{"example":"username","type":"string"},"description":"The MySQL server's username.","required":"true","in":"query","name":"mysql_user"},{"schema":{"type":"string","example":"12345luggage"},"description":"The MySQL server's password.","required":"true","in":"query","name":"mysql_pass"},{"description":"The MySQL server's port.","schema":{"minimum":"1","maximum":"65535","type":"integer","example":"3306"},"name":"mysql_port","in":"query","required":"true"},{"required":"false","name":"setup_via","in":"query","schema":{"example":"Main terminal","maxLength":"255","type":"string"},"description":"A description of the profile data.\n\n**Note:**\n\nThis parameter defaults to `User provided\nMySQL credentials`."},{"in":"query","name":"cpcloud","required":"false","description":"Whether the remote database profile is a cPanel Cloud deployment.\n\n* `1` — Is cPanel Cloud.\n* `0` — **Not** cPanel Cloud.","schema":{"example":"1","default":"0","type":"integer"}}],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"remote_mysql_create_profile","description":"The method name called.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}},"data":{"type":"object","properties":{"profile_saved":{"description":"The new profile's name.","example":"MyProfile","type":"string"},"profile_details":{"properties":{"mysql_host":{"oneOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"hostname"}],"example":"192.168.0.1","description":"The MySQL server's IP address or hostname."},"mysql_user":{"type":"string","example":"username","description":"The MySQL server's username."},"active":{"type":"integer","description":"Whether the system uses this profile to access the MySQL server.\n* `1` — Active.\n* `0` — **Not** active.","enum":["0","1"],"example":"0"},"setup_via":{"description":"A description of the profile data.","example":"Main terminal","maxLength":"255","type":"string"},"mysql_pass":{"description":"The MySQL server's password.","example":"12345luggage","type":"string"},"mysql_port":{"minimum":"1","maximum":"65535","type":"integer","example":"3306","description":"The MySQL server's port."},"cpcloud":{"type":"integer","example":"0","enum":["0","1"],"default":"0","description":"Whether the remote database profile is a cPanel Cloud deployment.\n\n* `1` — Is cPanel Cloud.\n* `0` — **Not** cPanel Cloud."}},"type":"object","description":"An object containing the new profile's data."}}}}}}},"description":"HTTP Request was successful."}}}}},"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"description":"Databases / Remote MySQL Databases","name":"Remote MySQL Databases"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"get_featurelist_data":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"paths":{"/get_featurelist_data":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"featurelist":{"type":"string","description":"The feature list's name.","example":"Mail Only"},"features":{"description":"An array of objects containing the feature's information.","items":{"required":["id","is_disabled","value"],"type":"object","properties":{"is_standalone_experience":{"type":"integer","description":"Whether the system auto-redirects the user to the redirect_url when this feature is enabled. Only one such feature may be enabled for a feature list.\n\n* `1` — The feature supports standalone mode.\n* `0` — The feature does not support standalone mode.","example":"0","enum":["1","0"]},"badge_label":{"type":"string","description":"Custom label shown on the feature manager interfaces. This label will be localized into the current users language.","example":"Auto Launch"},"value":{"type":"integer","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.","example":"1","enum":["1","0"]},"redirect_url":{"description":"The URL where users should be redirected to when logging into cPanel.","example":"https://example.com/standalone","type":"string"},"dependencies":{"type":"array","example":["ssl","dns"],"items":{"type":"string"},"description":"List of feature names that are required dependencies for this feature to function properly."},"only_one_rules":{"type":"array","description":"Array of regular expression patterns used to enforce mutual exclusion with other features. When this feature is enabled, any features matching these patterns cannot be enabled simultaneously. This is primarily used for standalone experiences where only one feature should redirect users upon login.\n\nEach pattern in the array is a regular expression that matches against feature IDs. For example, a pattern like `^standalone-.*` would match any feature starting with \"standalone-\".","items":{"type":"string"},"example":["^(standalone-email_trace|email_trace)$","^standalone-.*$"]},"badge_class":{"type":"string","description":"CSS class name to apply styling to the custom label in the feature manager interfaces.","example":"label-blue"},"is_disabled":{"enum":["1","0"],"example":"0","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.","type":"integer"},"suppress_plugin_label":{"type":"integer","enum":["1","0"],"example":"0","description":"Whether to suppress the display of the standard 'plugin' label in the feature manager.\n\n* `1` — Hide the plugin label.\n* `0` — Show the plugin label."},"name":{"description":"The feature's name.","example":"Email Trace","type":"string"},"id":{"type":"string","example":"email_trace","description":"The feature's ID."}}},"type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"get_featurelist_data","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"in":"query","name":"featurelist","required":"true","description":"The feature list for which to list information.","schema":{"type":"string","example":"\"Mail Only\""}}],"description":"This function lists features in a specific feature list.","operationId":"get_featurelist_data","summary":"Return feature list configuration","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_featurelist_data \\\n  featurelist='Mail Only'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_featurelist_data?api.version=1&featurelist=%22Mail%20Only%22","lang":"HTTP","label":"URL"}],"tags":["Packages","Feature Lists"]}}},"x-tagGroups":[{"tags":["Feature Lists"],"name":"Hosting Plans"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"setresellermainip":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"name":"Account Settings","description":"Resellers / Account Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Resellers","tags":["Account Settings"]}],"paths":{"/setresellermainip":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"description":"The method name called.","example":"setresellermainip","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"setresellermainip","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.","parameters":[{"description":"The reseller's username.","schema":{"type":"string","example":"username"},"name":"user","in":"query","required":"true"},{"description":"The IP address to assign to the reseller's account as the main shared IP address.","schema":{"type":"string","format":"ipv4","example":"192.168.0.20"},"in":"query","name":"ip","required":"true"}],"x-cpanel-api-version":"WHM API 1","summary":"Update reseller's main IP address","tags":["Resellers","Account Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  setresellermainip \\\n  user='username' \\\n  ip='192.168.0.20'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellermainip?api.version=1&user=username&ip=192.168.0.20","label":"URL","lang":"HTTP"}]}}}},"setresolvers":{"x-tagGroups":[{"tags":["Resolvers"],"name":"DNS"}],"paths":{"/setresolvers":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"setresolvers","type":"string"},"reason":{"example":"Your resolvers have been setup!","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"output":{"description":"Messages returned from the call.","type":"object","properties":{"messages":{"example":"Listed in order they are:\n192.168.0.20\n192.168.0.21\n2001:4860:4860::8888\n","type":"string"}}}}}}}}}}},"x-cpanel-available-version":"11","parameters":[{"required":"true","in":"query","name":"nameserver1","schema":{"example":"192.168.0.20","oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]},"description":"The server's primary resolver nameserver."},{"required":"true","in":"query","name":"nameserver2","schema":{"oneOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}],"example":"192.168.0.21","format":"ipv4"},"description":"The server's secondary resolver nameserver."},{"schema":{"oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}],"default":"","example":"2001:4860:4860::8888"},"description":"The server's tertiary resolver nameserver.","required":"false","name":"nameserver3","in":"query"}],"operationId":"setresolvers","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.","x-cpanel-api-version":"WHM API 1","summary":"Update server's resolver nameservers","tags":["DNS","Resolvers"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  setresolvers \\\n  nameserver1='192.168.0.20' \\\n  nameserver2='192.168.0.21'\n","lang":"Shell","label":"CLI"},{"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"}]}}},"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"description":"DNS / Resolvers","name":"Resolvers"}],"servers":[{"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."}},"description":"A server running WHM."}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"showbw":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"tags":[{"name":"Bandwidth and Disk Quotas","description":"Accounts / Bandwidth and Disk Quotas"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"name":"Accounts","tags":["Bandwidth and Disk Quotas"]}],"paths":{"/showbw":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"month":{"description":"The queried month.","example":"12","type":"integer","maximum":"12","minimum":"1"},"reseller":{"description":"The reseller username or the `root` user.","example":"root","type":"string"},"acct":{"description":"Bandwidth information for the reseller's accounts.","items":{"properties":{"totalbytes":{"example":"352","description":"The account's total bandwidth usage during the queried period, in bytes.","minimum":"0","type":"integer"},"user":{"type":"string","example":"user","description":"The account username."},"maindomain":{"type":"string","description":"The account's main domain.","example":"example.com"},"owner":{"type":"string","description":"The account's owner.","example":"root"},"reseller":{"type":"integer","example":"0","enum":["1","0"],"description":"Whether the user is a reseller.\n\n* `1` — Reseller account.\n* `0` — **Not** a reseller account."},"deleted":{"enum":["1","0"],"example":"0","description":"Whether the account was deleted.\n\n* `1` — Deleted.\n* `0` — **Not** deleted.","type":"integer"},"limit":{"description":"The account's bandwidth limit, in bytes.","example":"0","type":"integer","minimum":"0"},"bwusage":{"type":"array","description":"The bandwidth information for domains on the account.","items":{"properties":{"deleted":{"type":"integer","description":"Whether the account was deleted.\n\n* `1` — Deleted.\n* `0` — **Not** deleted.","example":"0","enum":["1","0"]},"domain":{"example":"example.com","description":"The domain on the account.","type":"string"},"usage":{"minimum":"0","type":"integer","example":"0","description":"The domain's bandwidth usage during the queried period, in bytes."}},"type":"object"}}},"type":"object"},"type":"array"},"totalused":{"description":"The total bandwidth usage of the reseller's accounts during the queried period, in bytes.","example":"352","type":"integer","minimum":"0"},"year":{"example":"2019","description":"The queried year.","type":"integer"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"description":"The method name called.","example":"showbw","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"name":"month","in":"query","required":"false","description":"The month to query, in numeric format.\n\nThis value defaults to the current month.","schema":{"example":"12","type":"integer","maximum":"12","minimum":"1"}},{"schema":{"type":"integer","example":"2019"},"description":"The year to query.\n\nThis value defaults to the current year.","required":"false","name":"year","in":"query"},{"required":"false","name":"showres","in":"query","schema":{"example":"reseller_user","type":"string"},"description":"The reseller to query.\n\nIf you do **not** specify a value, the function queries **all** users."},{"description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions)\nthat filters the results. The system matches the PCRE against the `searchtype`\nparameter's specified type.\n\nIf you do **not** specify a value for **both** the `searchtype` and `search`\nparameters, the function does **not** use the `search` criteria.","schema":{"example":"ownername","type":"string"},"name":"search","in":"query","required":"false"},{"schema":{"type":"string","enum":["domain","owner","user","ip","package"],"example":"owner"},"description":"The account information to query.\n\n* `domain` — Match domains against the `search` regular expression.\n* `owner` — Match the WHM user who owns the account against the `search`\nregular expression.\n* `user` — Match usernames against the `search` regular expression.\n* `ip` — Match IP addresses against the `search` regular expression.\n* `package` — Match hosting plans (packages) against the `search` regular\nexpression.\n\nIf you do **not** specify a value for **both** the `searchtype` and `search`\nparameters, the function does **not** use the `searchtype` value.","required":"false","name":"searchtype","in":"query"}],"operationId":"showbw","description":"This function retrieves account bandwidth information.","summary":"Return cPanel account bandwidth information","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  showbw\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/showbw?api.version=1"}],"tags":["Bandwidth and Disk Quotas"]}}}},"install_spf_records":{"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/install_spf_records":{"get":{"x-cpanel-available-version":"78","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"install_spf_records","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"payload":{"type":"array","items":{"properties":{"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"},"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"},"domain":{"type":"string","format":"domain","description":"The SPF record's associated domain on the DNS server.","example":"example.com"}},"type":"object"},"description":"An array of objects containing information about the domain's SPF record installation to the DNS server."}},"type":"object"}}}}}}},"operationId":"install_spf_records","description":"This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server.","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","format":"domain","example":"example.com"},"examples":{"multiple":{"value":"domain-1=example-1.com&domain-2=example-2.com&domain-3=example-3.com","summary":"Multiple domains"},"single":{"summary":"Single domain","value":"example.com"}},"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."},{"description":"An SPF record.\n\nYou **must** provide this parameter for every `domain` parameter.","schema":{"example":"v%3Dspf1%20%2Bip4%3A1192.0.2.0%20-all","type":"string"},"in":"query","name":"record","required":"true"}],"x-cpanel-api-version":"WHM API 1","summary":"Install domain SPF record","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"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","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","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-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}]},"modsec_deploy_settings_changes":{"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Server Settings","name":"Server Settings"}],"paths":{"/modsec_deploy_settings_changes":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","description":"The method name called.","example":"modsec_deploy_settings_changes"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}},"data":{"properties":{}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[],"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","summary":"Enable staged ModSecurity configuration files","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_deploy_settings_changes\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_deploy_settings_changes?api.version=1","label":"URL","lang":"HTTP"}],"tags":["ModSecurity","Server Settings"]}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"validate_current_ptrs":{"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"paths":{"/validate_current_ptrs":{"get":{"summary":"Validate domain PTR records","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  validate_current_ptrs \\\n  domain='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_ptrs?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}],"tags":["Mail","Mail DNS Settings"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"validate_current_ptrs","description":"The method name called."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"payload":{"items":{"properties":{"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":{"type":"string","description":"The fully qualified domain name (FQDN) that a PTR record points to."},"forward_records":{"items":{"type":"string"},"description":"An array of IP addresses that the domain resolves to for A (IPv4) and AAAA (IPv6) records.","type":"array"},"state":{"type":"string","enum":["VALID","MISSING_FWD","FWD_MISMATCH"],"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."}},"type":"object"},"type":"array"},"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"},"state":{"type":"string","enum":["ERROR","IP_IS_PRIVATE","VALID","MISSING_PTR","PTR_MISMATCH"],"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."},"helo":{"format":"hostname","description":"The hostname that the domain uses to identify itself to remote SMTP servers.","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":{"type":"integer","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."},"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":{"type":"string","description":"The queried domain."},"nameservers":{"type":"array","items":{"type":"string"},"description":"An array of the authoritative nameservers for the domain's PTR record."}},"type":"object"},"description":"An array of objects containing information about the account's PTR records.","example":[{"ptr_records":[{"forward_records":["10.0.0.1"],"domain":"example.com","state":"VALID"}],"state":"VALID","ip_version":"4","ip_address":"10.0.0.1","helo":"example.com","arpa_domain":"1.0.0.10.in-addr.arpa","domain":"example.com","nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"]},{"state":"PTR_MISMATCH","ip_address":"10.0.0.3","helo":"example.com","ip_version":"4","ptr_records":[{"state":"FWD_MISMATCH","forward_records":["192.168.12.34"],"domain":"example.com"}],"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"domain":"example.com","arpa_domain":"3.0.0.10.in-addr.arpa"},{"domain":"example.com","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","nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"ptr_records":[{"state":"VALID","domain":"example.com","forward_records":["2001:0db8:85a3:0000:0000:8a2e:0370:7334"]}],"ip_address":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","helo":"example.com","ip_version":"6","state":"VALID"},{"state":"MISSING_PTR","ip_address":"10.0.0.2","helo":"example.com","ip_version":"4","ptr_records":[],"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"domain":"example.com","arpa_domain":"2.0.0.10.in-addr.arpa"},{"ip_address":"1.1.1.1.1","helo":"thisothermaildomain.com","state":"ERROR","error":"1.1.1.1.1 is not a valid IP address.","ptr_records":[],"domain":"thisotheremaildomain.com"},{"helo":"example.com","ip_address":"10.0.0.4","ip_version":"4","state":"PTR_MISMATCH","ptr_records":[{"state":"MISSING_FWD","domain":"example.com","forward_records":[]}],"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"arpa_domain":"4.0.0.10.in-addr.arpa","domain":"example.com"}],"type":"array"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"78","parameters":[{"required":"true","in":"query","name":"domain","schema":{"type":"string"},"examples":{"single":{"value":"example.com","summary":"Validate a single domain's PTR records."},"multiple-alternative":{"summary":"Validate multiple domains' PTR records.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"multiple":{"summary":"Validate multiple domains' PTR records.","value":"domain-1=example.com domain-2=example2.com domain-3=example3.com"}},"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."}],"operationId":"validate_current_ptrs","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."}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_disk_usage":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Accounts / Bandwidth and Disk Quotas","name":"Bandwidth and Disk Quotas"}],"paths":{"/get_disk_usage":{"get":{"x-cpanel-available-version":"80","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"example":"get_disk_usage","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"accounts":{"items":{"type":"object","properties":{"inodes_used":{"minimum":"0","type":"integer","description":"The account's current inode usage.","example":"340"},"blocks_used":{"minimum":"0","type":"integer","description":"The account's current disk space usage, in kibibytes (KiB).","example":"2632"},"inodes_limit":{"nullable":"true","example":"9999","description":"The account's inode quota.\n* `null` - The account has an unlimited number of inodes.","type":"integer","minimum":"0"},"blocks_limit":{"minimum":"0","type":"integer","example":null,"description":"The account's disk space quota, in kibibytes (KiB).\n* `null` - The account has unlimited disk space.","nullable":"true"},"user":{"description":"The cPanel or Reseller account username.","example":"username","type":"string"}}},"description":"A list of objects containing the disk usage data for all accounts on the server.","type":"array"}}}},"type":"object"}}}}},"operationId":"get_disk_usage","description":"This function lists the disk usage status of the system's user accounts. This also lists information about file system object (inode) 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.","schema":{"default":"on","example":"on","enum":["on","off"],"type":"string"},"in":"query","name":"cache_mode","required":"false"}],"summary":"Return all cPanel accounts disk usage","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_disk_usage\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_disk_usage?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Bandwidth and Disk Quotas"]}}},"x-tagGroups":[{"name":"Accounts","tags":["Bandwidth and Disk Quotas"]}]},"loadavg":{"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"88","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"System Information"}],"paths":{"/loadavg":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"one":{"type":"number","description":"The server's load average over the previous minute.","example":"0.17"},"fifteen":{"type":"number","example":"0.18","description":"The server's load average over the previous five minutes."},"five":{"description":"The server's load average over the previous fifteen minutes.","example":"0.19","type":"number"}},"type":"object"}}}}},"x-cpanel-internal-only":"true","x-cpanel-cli-support":"false","x-codeSamples":[{"source":"https://hostname.example.com:2087/cpsess##########/json-api/loadavg?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11","operationId":"loadavg","description":"This function retrieves the server's load average. The values the function returns represent\na percentage of the CPU's processor capacity.\n\n**Important:**\n\n* This function does **not** include metadata.\n* This function is **not** available through the command line. You **must** call it\nas a request body.\n* You can use WHM API 1's `systemloadavg` function to retrieve this data via the\ncommand line.","parameters":[],"summary":"Get system load average","x-cpanel-api-version":"WHM API 1","tags":["System Information"]}}},"x-tagGroups":[{"name":"Server Administration","tags":["System Information"]}]},"personalization_set":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/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","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"personalization_set"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"personalization":{"description":"The saved personalization information on the server.","example":{"milk":{"reason":"OK","value":"cold","success":"1"},"coffee":{"reason":"OK","value":"hot","success":"1"}},"type":"object","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":{"example":"1","enum":["0","1"],"description":"Whether the function successfully saved the value on the server.\n* `1` - Successful.\n* `0` - Unsuccessful.","type":"integer"},"value":{"nullable":"true","example":"hot","description":"The value stored in the field or `null` if the property is not available in the datastore.","type":"string"}},"type":"object"}}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"74","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"},{"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\"}","label":"HTTP Request (Wire Format)","lang":"HTTP"}],"tags":["Server Administration","Account Management"],"requestBody":{"content":{"application/json":{"schema":{"example":{"store":"beverages","personalization":{"milk":"cold","coffee":"hot"},"api.version":"1"},"properties":{"store":{"maxLength":"128","type":"string","example":"beverages","description":"The name under which the values will be stored."},"personalization":{"type":"object","description":"An object you want to store."},"api.version":{"enum":["1"],"description":"The WHM API version number","type":"integer"}},"required":["api.version","personalization"],"type":"object"}}}},"summary":"Save data to NVData file","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Account Management","description":"Accounts / Account Management"}]},"getdiskusage":{"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"System Information","description":"Server Administration / System Information"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["System Information"],"name":"Server Administration"}],"paths":{"/getdiskusage":{"get":{"parameters":[],"operationId":"getdiskusage","description":"This function retrieves the server's drive partition information.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Successfully retrieved disk usage"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"getdiskusage","description":"The method name called.","type":"string"}}},"data":{"properties":{"partition":{"type":"array","items":{"properties":{"inodes_ipercentage":{"type":"integer","minimum":"0","example":"2","description":"The percentage of the partition's total"},"disk":{"example":"vda1","description":"The partition's label.","type":"string"},"inodes_used":{"type":"integer","minimum":"1","description":"The number of inodes used on the partition.","example":"395097"},"device":{"type":"string","description":"The partition's device name.","example":"/dev/vda1"},"total":{"minimum":"1","type":"integer","example":"495844","description":"The partition's total allocated disk space, measured in kilobytes.","format":"kilobytes"},"mount":{"description":"The partition's mount point.","example":"/boot","type":"string"},"inodes_available":{"example":"20575847","description":"The number of unused inodes on the partition.","minimum":"1","type":"integer"},"filesystem":{"example":"/","description":"The partition's absolute directory path.","type":"string"},"percentage":{"example":"20","description":"The percentage of the partition's total disk space used.","minimum":"1","type":"integer"},"used":{"type":"integer","minimum":"1","format":"kilobytes","description":"The partition's disk space used, measured in kilobytes.","example":"92388"},"inodes_total":{"minimum":"1","type":"integer","example":"20970944","description":"The total number of inodes that the partition will allow."},"available":{"description":"The partition's unused disk space, measured in kilobytes.","format":"kilobytes","example":"377856","minimum":"1","type":"integer"}},"type":"object"},"description":"An array of objects that contain drive partition information."}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11.32","tags":["Server Administration","System Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  getdiskusage\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/getdiskusage?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return server's drive partition information"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"}},"restore_queue_clear_completed_task":{"paths":{"/restore_queue_clear_completed_task":{"get":{"summary":"Remove completed restoration task","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  restore_queue_clear_completed_task \\\n  user='username' \\\n  start_time='1396065600'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_completed_task?api.version=1&user=username&start_time=1396065600","lang":"HTTP","label":"URL"}],"tags":["Account Restoration","Restore Queue Management"],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"example":"restore_queue_clear_completed_task","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"restore_queue_clear_completed_task","description":"This function removes a single completed task from the restoration queue.","parameters":[{"schema":{"type":"string","format":"username","example":"username"},"description":"The cPanel account's username.","required":"true","in":"query","name":"user"},{"required":"true","in":"query","name":"start_time","schema":{"format":"unix_timestamp","example":"1396065600","type":"integer"},"description":"When the restoration queue started the restoration."}]}}},"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Management"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"description":"Account Restoration / Restore Queue Management","name":"Restore Queue Management"}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"list_database_users":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"description":"Databases / MySQL Databases","name":"MySQL Databases"}],"paths":{"/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":[],"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"payload":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"example_user1","description":"The database user's name."},"cpuser":{"type":"string","example":"example","description":"The database user's owner."},"engine":{"description":"The database user's database engine.\n* `mysql`\n* `postgresql`","enum":["mysql","postgresql"],"example":"postgresql","type":"string"}}},"description":"An array of database data objects."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"list_database_users","description":"The method name called.","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}}}}}}},"tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  list_database_users\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_database_users?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return MySQL users"}}},"x-tagGroups":[{"tags":["MySQL Databases"],"name":"Databases"}]},"modsec_set_setting":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Server Settings","name":"Server Settings"}],"paths":{"/modsec_set_setting":{"get":{"x-cpanel-available-version":"11.46","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"modsec_set_setting","description":"The method name called."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"type":"object","properties":{"radio_options":{"type":"array","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":{"option":{"example":"On","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.","type":"string"},"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"}},"type":"object"}},"description":{"example":"This setting allows you to define the match limit of the PCRE library.","description":"The setting's description.","type":"string"},"setting_id":{"example":"8","description":"The setting's ID.","minimum":"0","type":"integer"},"state":{"description":"The setting's new state.","example":"2000","type":"integer"},"name":{"type":"string","example":"PCRE library match limit","description":"The setting's name."},"url":{"type":"string","example":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit","format":"url","description":"The URL for the setting's documentation."},"default":{"type":"string","example":"1500","description":"The setting's default value."},"validation":{"type":"array","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":{"name":{"description":"The method that determines where the validator should match a pattern in a user's input.","example":"startsWith"},"arg":{"description":"The regular expression pattern that is used with `name` when the validator checks a user's input.","example":"[Ee]xample"}},"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.","example":"positiveInteger","enum":["path","honeypotAccessKey","positiveInteger"],"type":"string"}]}},"directive":{"description":"The setting's Apache® directive.","example":"SecPcreMatchLimit","type":"string"},"type":{"type":"string","example":"text","enum":["text","radio","number"],"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."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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":[{"name":"setting_id","in":"query","required":"true","description":"The setting's ID.\n\n**Note:**\n\n The WHM API 1 `modsec_get_settings` function returns this value.","schema":{"type":"integer","minimum":"0","example":"8"}},{"schema":{"example":"2000","type":"string"},"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).","required":"true","in":"query","name":"state"}],"x-cpanel-api-version":"WHM API 1","summary":"Update ModSecurity configuration","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_set_setting \\\n  setting_id='8' \\\n  state='2000'\n","lang":"Shell","label":"CLI"},{"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-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"enqueue_transfer_item":{"components":{"schemas":{"Transfers_EnqueueTransferItem_Type_LegacyAccountBackup":{"allOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Base"},{"properties":{"restoresubs":{"enum":["0","1"],"description":"Whether to restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","type":"integer"},"restoreall":{"description":"Whether to recreate the account on the target server.\n\n* `1` — Recreate.\n* `0` — Do **not** recreate.","enum":["0","1"],"type":"integer"},"restoreip":{"type":"integer","description":"Whether to assign the account's dedicated IP address that is stored in the backup file.\n\n* `1` — Assign.\n* `0` — Do **not** assign.","enum":["0","1"]},"unrestricted_restore":{"enum":["0","1"],"description":"Whether to bypass the *Restricted Restore* system.\n\n* `1` — Bypass.\n* `0` — Do **not** bypass.","type":"integer"},"restoremail":{"description":"Whether to restore the account's mail data.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","enum":["0","1"],"type":"integer"},"restoretype":{"enum":["monthly","weekly","daily"],"example":"daily","description":"The backup type to restore.\n\n* `monthly`\n* `weekly`\n* `daily`","type":"string"},"user":{"example":"user","description":"The account's username.","format":"username","type":"string"},"restoremysql":{"type":"integer","enum":["0","1"],"description":"Whether to restore MySQL® database data.\n\n* `1` — Restore.\n* `0` — Do **not** restore."},"overwrite_sameowner_dbusers":{"type":"integer","enum":["0","1"],"description":"Whether to allow the system to overwrite the account's existing database users with the database users in the backup file.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite."},"overwrite_sameowner_dbs":{"type":"integer","enum":["0","1"],"description":"Whether to allow the system to overwrite the account's existing databases with the databases in the backup file.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite."},"restorebwdata":{"enum":["0","1"],"description":"Whether to restore bandwidth data.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","type":"integer"},"overwrite_all_dbs":{"description":"Whether to allow the system to overwrite all of the account's databases with the databases in the backup file.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.\n\n**Note:**\n\nYou may use only **one** of the following parameters:\n\n* `overwrite_all_dbs`\n* `overwrite_sameowner_dbs`\n* Both the `mysql_dbs_to_restore` and `pgsql_dbs_to_restore` parameters.\n\nIf you do not use any of these parameters, the system will restore all of the databases on the account, but will **not** overwrite any of them.\n\n**Warning:**\n\nThe _Restricted Restore_ feature does not allow an account to overwrite data that it does not own. If the transfer session's `unrestricted_restore` parameter has a value of `0`, the `overwrite_all_dbs` parameter will automatically change to a value of `0` and the `overwrite_sameowner_dbs` parameter will change to a value of `1`. This prevents the restore system from overwriting databases that the account does not own.","enum":["0","1"],"type":"integer"},"pgsql_dbs_to_restore":{"type":"string","description":"A comma-separated list of PostgreSQL® databases to restore, which will overwrite those databases on the account.\n\n**Note:**\n\nThe default behavior is to select and overwrite all databases.\n\n**Warning:**\n\nThe _Restricted Restore_ feature does not allow an account to overwrite data that it does not own. If the transfer session's `unrestricted_restore` parameter has a value of `0`, this parameter is ignored.","example":"pgdb1,pgdb2,pgdb3"},"mysql_dbs_to_restore":{"example":"msdb1,msdb2,msdb3","description":"A comma-separated list of MySQL databases to restore, which will overwrite those databases on the account.\n\n**Note:**\n\nThe default behavior is to select and overwrite all databases.\n\n**Warning:**\n\nThe _Restricted Restore_ feature does not allow an account to overwrite data that it does not own. If the transfer session's `unrestricted_restore` parameter has a value of `0`, this parameter is ignored.","type":"string"}},"type":"object","required":["user","restoretype"]}]},"Transfers_EnqueueTransferItem_Type_Account_Base":{"allOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Base"},{"properties":{"customip":{"description":"The custom IP address to assign to the transferred account.\n\n**Note:**\n\nThis parameter requires that the `ip` parameter has a value of `1`.","example":"192.168.0.1","type":"string"},"skiphomedir":{"type":"integer","description":"Whether to skip the contents of the home directory.\n\n* `1` — Skip.\n* `0` — Restore.","enum":["0","1"],"example":"1"},"mail_location":{"description":"The server on which the account's email will reside after it completes the transfer.\n\n* `.local` — The local server.\n* `.existing` — Use the location defined in the account's backup data.\n* The alias (friendly name) of a remote [cPanel & WHM linked server node.](https://go.cpanel.net/whmdocsLinkServerNodes). For example, the `example-alias` for the `servernode.example.com` domain.\n\n**Note:**\n\nThe system will use the `.local` option if:\n  * The system cannot use the cPanel & WHM linked server node when you call the `.existing` option.\n  * The cPanel & WHM linked server node's alias (friendly name) is invalid.","default":".existing","example":".local","oneOf":[{"enum":[".local",".existing"],"type":"string"},{"type":"string","description":"A remote cPanel & WHM linked server node's alias (friendly name)."}]},"skipaccount":{"example":"1","enum":["0","1"],"description":"Whether to skip the recreation of the account.\n\n* `1` — Skip.\n* `0` — Restore.\n\n**Note:**\n\n* The values you enter for the `user` and `localuser` parameters **must** match.\n* This parameter is similar to the `force` parameter, but performs none of the account creation steps.","type":"integer"},"localuser":{"description":"The local account's username.","format":"username","example":"localuser","type":"string"},"replaceip":{"example":"all","enum":["all","basic"],"description":"The lines in the domain's zonefile to replace with the new IP address.\n\n* `all` — Replace all of the matching `A` record addresses in the zone file with the new IP address, including custom `A` records.\n* `basic` — Replace **only** the cPanel-managed `A` records for this IP address. This includes the main domain and any [service subdomains](https://go.cpanel.net/ServiceProxySubdomains).","type":"string"},"overwrite_sameowner_dbs":{"example":"1","enum":["0","1"],"description":"Whether to allow the system to overwrite the account's existing databases with the databases in the backup file.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.","type":"integer"},"skipres":{"example":"1","enum":["0","1"],"description":"Whether to skip restoration of the account's reseller permissions.\n\n* `1` — Skip.\n* `0` — Restore.","type":"integer"},"detected_remote_user":{"example":"user","description":"The user account name that the remote server returns when you query the user account.","type":"string"},"domain":{"type":"string","example":"example.com","description":"The domain name.","format":"domain"},"overwrite_sameowner_dbusers":{"type":"integer","description":"Whether to allow the system to overwrite the account's existing database users with the database users in the backup file.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.","enum":["0","1"],"example":"1"},"ip":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether to assign a dedicated IP address to the transferred account.\n\n* `1` — Assign a dedicated IP address.\n* `0` — Do **not** assign a dedicated IP address.\n\n**Note:**\n\nIf no dedicated IP address exists, the system assigns the account to a shared IP address."},"overwrite_with_delete":{"type":"integer","description":"Whether to replace and delete **all** directories and files on the destination server.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.\n\n**Warning:**\n\nIf you use this parameter, the system deletes **every** directory and file on the destination server. The system does **not** delete the directories and files from the source server.","example":"1","enum":["0","1"]},"skipacctdb":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether to skip the transfer of the account's databases.\n\n* `1` — Skip.\n* `0` — Restore."},"user":{"type":"string","example":"user","description":"The account to transfer.","format":"username"},"shared_mysql_server":{"description":"Whether one of the following conditions is true:\n\n* The target and remote servers share the same remote MySQL server.\n* The target server is the remote MySQL server for the remote server.\n* The remote server is the remote MySQL server for the target server.\n\nValue:\n\n* `1` — One is true.\n* `0` — None are true.","enum":["0","1"],"example":"1","type":"integer"},"skipbwdata":{"type":"integer","description":"Whether to skip the transfer of the account's bandwidth data.\n\n* `1` — Skip.\n* `0` — Restore.","enum":["0","1"],"example":"1"},"reseller":{"type":"integer","description":"Whether to make the account a reseller.\n\n* `1` — Make the account a reseller account.\n* `0` — Do **not** make the account a reseller account.","enum":["0","1"],"example":"1"}},"type":"object","required":["user","localuser"]}]},"Transfers_EnqueueTransferItem_Base":{"type":"object","required":["transfer_session_id","module"],"properties":{"module":{"type":"string","description":"The transfer system module.\n\n* `LegacyAccountBackup` — This module restores legacy-account backup files.\n* `FeatureListRemoteRoot` — This module transfers the feature list from the remote server.\n* `PackageRemoteRoot` — This module transfers the package settings.\n* `AccountLocal` — This module restores backup files.\n* `AccountRemoteRoot` — This module uses the `root` credentials to transfer account settings that are not a part of a package.\n* `AccountRemoteUser` — This module uses the account's user credentials to transfer account settings that are not a part of a package.\n\n**Note:**\n\n* The `module` parameter determines which additional parameters to use with the function.\n* You **must** perform each module action as a separate step.\n\nWhen you call this function, you **must** include the additional parameters for the desired transfer system module. Select a module from the menu to view its required additional parameters:","example":"AccountRemoteRoot"},"transfer_session_id":{"description":"The transfer session's ID.","example":"vm5docscpanelcopya20140211211719FxjU","type":"string"},"size":{"example":"133698","description":"The size of the content to transfer, in bytes.\nThe restore system uses this value to determine the best filesystem\npartition for the restored account’s home directory. For best\nresults, give as accurate of a value as possible.","default":"1","minimum":"1","type":"integer"}}},"Transfers_EnqueueTransferItem_Type":{"anyOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountLocal_or_AccountRemoteRoot"},{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountRemoteRoot"},{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountRemoteUser"},{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_FeatureListRemoteRoot"},{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_LegacyAccountBackup"},{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_PackageRemoteRoot"}],"discriminator":{"mapping":{"LegacyAccountBackup":"#/components/schemas/Transfers_EnqueueTransferItem_Type_LegacyAccountBackup","PackageRemoteRoot":"#/components/schemas/Transfers_EnqueueTransferItem_Type_PackageRemoteRoot","AccountRemoteRoot":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountRemoteRoot","AccountLocal":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountLocal_or_AccountRemoteRoot","FeatureListRemoteRoot":"#/components/schemas/Transfers_EnqueueTransferItem_Type_FeatureListRemoteRoot","AccountRemoteUser":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountRemoteUser"},"propertyName":"module"}},"Transfers_EnqueueTransferItem_Type_AccountRemoteUser":{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_Account_Base"},"Transfers_EnqueueTransferItem_Type_PackageRemoteRoot":{"allOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Base"},{"required":["package"],"type":"object","properties":{"package":{"type":"string","example":"user_package","description":"The package's name."}}}]},"Transfers_EnqueueTransferItem_Type_AccountRemoteRoot":{"allOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_AccountLocal_or_AccountRemoteRoot"},{"properties":{"xferpoint":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether to use the [*Express Transfer*](https://go.cpanel.net/livetransfer) feature.\n\n* `1` — Use.\n* `0` — Do **not** use."},"live_transfer":{"enum":["0","1"],"example":"1","description":"Whether to use the [*Live Transfer*](https://go.cpanel.net/livetransfers) feature.\n\n* `1` — Use.\n* `0` — Do **not** use.","default":"0","type":"integer"}}}]},"Transfers_EnqueueTransferItem_Type_FeatureListRemoteRoot":{"allOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Base"},{"properties":{"featurelist":{"description":"The feature list's name.","example":"user_features","type":"string"}},"required":["featurelist"],"type":"object"}]},"Transfers_EnqueueTransferItem_Type_AccountLocal_or_AccountRemoteRoot":{"allOf":[{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type_Account_Base"},{"properties":{"force":{"enum":["0","1"],"example":"1","description":"Whether to overwrite an account with an identical username.\n\n* `1` — Overwrite the account.\n* `0` — Do **not** overwrite the account.\n\nThis parameter performs the following actions:\n\n* Restores the cPanel account on the destination server.\n* Overwrites all account settings, data, and databases.\n* Ignores errors and warnings for naming conflicts.\n\n**Note:**\n\n* The values you enter for the `user` and `localuser` parameters **must** match.\n* You cannot use this parameter if you called the WHM API 1 `create_remote_root_transfer_session` function with the `unrestricted_restore` parameter set to `1`.","type":"integer"}},"type":"object"}]}},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","x-tagGroups":[{"name":"Transfers","tags":["cPanel Account Transfer"]}],"paths":{"/enqueue_transfer_item":{"get":{"x-codeSamples":[{"source":"whmapi1 --input=json --output=jsonpretty \\\n  enqueue_transfer_item\n","lang":"Shell","label":"CLI"},{"source":"GET /cpsess##########/json-api/enqueue_transfer_item HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n","label":"HTTP Request (Wire Format)","lang":"HTTP"}],"requestBody":{"description":"An enqueue transfer item.","content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Transfers_EnqueueTransferItem_Type"}}}},"tags":["Transfers","cPanel Account Transfer"],"summary":"Add module to transfer session","x-cpanel-api-version":"WHM API 1","description":"This function adds a transfer session to a queue. For more information about how this function works with other\nfunctions in the transfer and restore process, read our\n[Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.\n\n**Important:**\n\nThe `module` parameter determines which additional parameters to use with the function.","operationId":"enqueue_transfer_item","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"enqueue_transfer_item","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44"}}},"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"name":"cPanel Account Transfer","description":"Transfers / cPanel Account Transfer"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"backup_set_list":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup or Restore","name":"Backup or Restore"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"tags":["Backup or Restore"],"name":"Backups"}],"paths":{"/backup_set_list":{"get":{"x-cpanel-api-version":"WHM API 1","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-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"backup_set_list","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"backup_set":{"items":{"type":"object","properties":{"backup_date":{"items":{"type":"string","example":"2014-01-01T00:00:00.000Z"},"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.","type":"array"},"user":{"description":"The backup file set's owner. A valid username.","example":"username","type":"string"}}},"description":"hash of a user's backup information. This hash includes the user and backup_date returns.","type":"object","properties":{}}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"description":"This function lists backup files for the server's accounts in the local disk.","operationId":"backup_set_list","parameters":[]}}}},"stage_services_cluster_node":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/stage_services_cluster_node":{"get":{"operationId":"stage_services_cluster_node","description":"This function stages a new Services Cluster node.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","parameters":[{"schema":{"example":"server1","type":"string","pattern":"^[a-z][a-z0-9]*$"},"description":"A friendly name for the node.","name":"name","in":"query"},{"name":"ip_address","in":"query","description":"The node's internal IP address.","schema":{"format":"ipv4","example":"10.0.1.1","type":"string"}},{"schema":{"type":"string","enum":["server","agent"],"example":"server"},"description":"* `server` - The node is acting as a server node in the cluster.\n* `agent` - The node is acting as an agent node in the cluster.","name":"role","in":"query"},{"name":"ssh_key","in":"query","description":"The name of the SSH key the system uses for authentication during deployment.","schema":{"example":"id_rsa","type":"string"}}],"x-cpanel-internal-only":"true","x-cpanel-available-version":"11.110","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"stage_services_cluster_node","description":"The method name called."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}},"data":{"properties":{"nodes":{"items":{"properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9]*$","description":"A friendly name for the node.","example":"server1"},"ssh_key":{"type":"string","example":"id_rsa","description":"The name of the SSH key the system uses for authentication during deployment."},"ip_address":{"description":"The node's internal IP address.","format":"ipv4","example":"10.0.1.1","type":"string"},"role":{"type":"string","example":"server","enum":["server","agent"],"description":"* `server` - The node is acting as a server node in the cluster.\n* `agent` - The node is acting as an agent node in the cluster."}}},"description":"An array of objects containing currently staged services cluster nodes."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  stage_services_cluster_node \\\n  name=server1 \\\n  ip_address='10.0.1.1' \\\n  role=server \\\n  ssh_key=id_rsa\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/stage_services_cluster_node?name=server1&ip_address=10.0.1.1&role=server&ssh_key=id_rsa"}],"tags":["ServicesCluster"],"summary":"Stage a services cluster node","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["ServicesCluster"],"name":"ServicesCluster"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"description":"The ServicesCluster module for WHM API 1.","name":"ServicesCluster"},{"name":"ServicesCluster","description":"ServicesCluster"}]},"acctcounts":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"description":"Resellers / Account Settings","name":"Account Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Resellers","tags":["Account Settings"]}],"paths":{"/acctcounts":{"get":{"description":"This function lists a reseller's total accounts, suspended accounts, and account creation limit.","operationId":"acctcounts","parameters":[{"required":"false","in":"query","name":"user","schema":{"format":"username","example":"username","type":"string"},"description":"A reseller's username, to query that reseller. If you do not specify a value, the function lists information for the authenticated account."}],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"reseller":{"description":"An object that contains information for an account.","properties":{"user":{"type":"string","description":"The reseller account's username or the `root` user.","example":"root"},"limit":{"type":"integer","minimum":"1","nullable":"true","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"},"suspended":{"example":"5","description":"The number of suspended accounts that the reseller account owns.","nullable":"true","minimum":"1","type":"integer"},"active":{"description":"The number of active accounts that the reseller account owns.","example":"9","minimum":"1","type":"integer"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"acctcounts","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  acctcounts\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/acctcounts?api.version=1"}],"tags":["Resellers","Account Settings"],"summary":"Return reseller's owned accounts' information","x-cpanel-api-version":"WHM API 1"}}}},"setsiteip":{"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"name":"IPv4 Address Settings","description":"IP Address Management / IPv4 Address Settings"}],"paths":{"/setsiteip":{"get":{"operationId":"setsiteip","description":"This function changes a site's or account's IP address.","parameters":[{"schema":{"example":"192.168.4.10","format":"ipv4","type":"string"},"description":"The site's or user's IPv4 address.","required":"true","in":"query","name":"ip"},{"name":"user","in":"query","schema":{"example":"username","format":"username","type":"string"},"description":"The user's username.\n\n**Note:**\n\nYou **must** use either the `user` parameter or `domain` parameter."},{"name":"domain","in":"query","schema":{"type":"string","format":"domain","example":"example.com"},"description":"The domain's name.\n\n**Note:**\n\nYou **must** use either the `user` parameter or `domain` parameter."}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"description":"The method name called.","example":"setsiteip","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}}}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  setsiteip \\\n  ip='192.168.4.10'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/setsiteip?api.version=1&ip=192.168.4.10","label":"URL","lang":"HTTP"}],"tags":["IP Addresses","IPv4 Address Settings"],"summary":"Update domain or cPanel account IP address","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["IPv4 Address Settings"],"name":"IP Address Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"set_primary_servername":{"paths":{"/set_primary_servername":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_primary_servername?api.version=1&servername=hostname.example.com","label":"URL","lang":"HTTP"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"set_primary_servername","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"required":"true","name":"servername","in":"query","schema":{"type":"string","format":"domain","example":"hostname.example.com"},"description":"The `ServerName` value in Apache's `VirtualHost` section to set as primary for the IP address and port type."},{"name":"type","in":"query","required":"false","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`.","schema":{"type":"string","default":"std","example":"std","enum":["std","ssl"]}}],"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"}}},"x-tagGroups":[{"tags":["System Information"],"name":"Server Administration"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / System Information","name":"System Information"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"load_cphulk_config":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"name":"Settings","description":"Login Security (cPHulk) / Settings"}],"paths":{"/load_cphulk_config":{"get":{"tags":["cPHulk","Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  load_cphulk_config\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/load_cphulk_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return login security configuration settings","operationId":"load_cphulk_config","description":"This function returns cPHulk's current settings.","parameters":[],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cphulk_config":{"type":"object","properties":{"can_temp_ban_firewall":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether to add temporary IP bans via the server's firewall.\n* `1` - Add.\n* `0` - Don't add."},"command_to_run_on_brute_force":{"type":"string","example":"echo \"BRUTE\"","description":"The command to run when the system detects a brute force attack. A valid BASH command."},"block_excessive_brute_force_with_firewall":{"type":"integer","description":"Whether to use the server's firewall to block excessive brute force attacks.\n* `1` - Block.\n* `0` - Don't block.","example":"1","enum":["0","1"]},"username_based_protection_local_origin":{"description":"Whether cPHulk will only track failed logins for requests originating locally.\n* `1` - Track.\n* `0` - Don't track.","example":"1","enum":["0","1"],"type":"integer"},"is_enabled":{"type":"integer","description":"Whether the cPHulk service is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","example":"1","enum":["0","1"]},"notify_on_brute":{"type":"integer","description":"Whether cPHulk will send a notification when it detects a brute force attack.\n* `1` - Send.\n* `0` - Do not send.","example":"1","enum":["0","1"]},"notify_on_root_login":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether cPHulk will send a notification when the root user successfully logs in from an IP address that is not on the whitelist.\n* `1` - Send.\n* `0` - Do not send."},"brute_force_period_sec":{"type":"integer","minimum":"1","description":"The number of seconds over which cPHulk measures all login attempts to a specific user's account.","example":"360"},"username_based_protection_for_root":{"example":"1","enum":["0","1"],"description":"Whether cPHulk will track the root user's failed logins.\n* `1` - Track.\n* `0` - Don't track.","type":"integer"},"block_brute_force_with_firewall":{"enum":["0","1"],"example":"1","description":"Whether to use the server's firewall to block brute force attacks.\n* `1` - Block.\n* `0` - Don't block.","type":"integer"},"mark_as_brute":{"example":"30","description":"The maximum number of failures that cPHulk will allow per account from a specific IP address before the system locks out that address for two weeks.","minimum":"0","type":"integer"},"brute_force_period_mins":{"description":"The number of minutes during which cPHulk measures all login attempts to a specific user's account.","example":"5","type":"integer","minimum":"1"},"command_to_run_on_excessive_brute_force":{"example":"echo \"TOO MUCH BRUTE\"","description":"The command to run when the system detects an excessive brute force attack. A valid BASH command.","type":"string"},"ip_brute_force_period_sec":{"type":"integer","minimum":"1","example":"300","description":"The number of seconds during which cPHulk measures an attacker's login attempts."},"max_failures":{"minimum":"0","type":"integer","description":"The maximum number of failures that cPHulk will allow per account within the defined time range.","example":"30"},"ip_brute_force_period_mins":{"example":"15","description":"The number of minutes during which cPHulk measures an attacker's login attempts.","type":"integer","minimum":"1"},"max_failures_byip":{"type":"integer","minimum":"0","example":"5","description":"The maximum number of failures that cPHulk will allow per account from a specific IP address within the defined time range."},"lookback_time":{"example":"21600","description":"The number of seconds during which cPHulk counts failed logins against a user.","type":"integer","minimum":"1"},"notify_on_root_login_for_known_netblock":{"description":"Whether cPHulk will send a notification when the root user successfully logs in from an IP address in the same netblock.\n* `1` - Send.\n* `0` - Do not send.","example":"1","enum":["0","1"],"type":"integer"},"username_based_protection":{"description":"Whether cPHulk will track failed logins by username.\n* `1` - Track.\n* `0` - Don't track.","example":"1","enum":["0","1"],"type":"integer"},"lookback_period_min":{"minimum":"1","type":"integer","example":"360","description":"The number of minutes during which cPHulk counts failed logins against a user."},"ip_based_protection":{"enum":["0","1"],"example":"1","description":"Whether cPHulk will track failed login attempts via IP addresses.\n* `1` - Track.\n* `0` - Don't track.","type":"integer"}},"description":"An object that contains cPHulk's current settings."}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"load_cphulk_config","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Settings"]}]},"cpsc_remove":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"cPCloud related WHM API 1 functions.","name":"cPCloud"}],"paths":{"/cpsc_remove":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cpsc_remove \\\n  service=database\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_remove?api.version=1&service=database"}],"tags":["cPCloud"],"summary":"Remove a cPCloud Service.","x-cpanel-api-version":"WHM API 1","description":"\"This function removes a cPCloud Service. This is a destructive process that destroys ALL data.\"","operationId":"cpsc_remove","x-cpanel-internal-only":"true","parameters":[{"description":"The name of the service to remove.","schema":{"type":"string","example":"database"},"in":"query","name":"service","required":"true"}],"x-cpanel-available-version":"11.112","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{},"type":"object","description":"A key value hash specific to the service that was removed."},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"cpsc_remove","description":"The method name called."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["cPCloud"],"name":"cPCloud"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.111.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"backup_destination_set":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{"BackupDestinationSetParameterRsync":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"username":{"type":"string","description":"The remote server account's username.","example":"username"},"host":{"type":"string","example":"backups.example.com","description":"The remote server's hostname.","format":"domain"},"authtype":{"description":"The authorization type.\n* `password`\n* `key`","example":"password","enum":["password","key"]},"privatekey":{"example":"/home/backups/key","format":"path","description":"If the `authtype` parameter's value is `key`, the absolute path to the private key file.","type":"string"},"password":{"type":"string","example":"123456luggage","description":"If the `authtype` parameter's value is `password`, the remote server account's password."},"path":{"type":"string","example":"/backups","description":"The path to the backups directory on the remote server.","format":"path"},"passphrase":{"example":"123456luggage","description":"If the `authtype` parameter's value is `key`, the private key file's passphrase.","type":"string"},"port":{"minimum":"1","type":"integer","maximum":"65535","default":"22","description":"The remote server's FTP port.","example":"22"},"timeout":{"default":"30","description":"The session timeout, in seconds.","example":"300","minimum":"30","type":"integer","maximum":"300"}},"required":["host","path","username","authtype"],"type":"object"}]},"BackupDestinationSetParameterType":{"discriminator":{"propertyName":"type","mapping":{"Backblaze":"#/components/schemas/BackupDestinationSetParameterBackblaze","GoogleDrive":"#/components/schemas/BackupDestinationSetParameterGoogleDrive","AmazonS3":"#/components/schemas/BackupDestinationSetParameterAmazonS3","Rsync":"#/components/schemas/BackupDestinationSetParameterRsync","WebDAV":"#/components/schemas/BackupDestinationSetParameterWebDAV","Custom":"#/components/schemas/BackupDestinationSetParameterCustom","Local":"#/components/schemas/BackupDestinationSetParameterLocal","S3Compatible":"#/components/schemas/BackupDestinationSetParameterS3Compatible","SFTP":"#/components/schemas/BackupDestinationSetParameterSFTP","FTP":"#/components/schemas/BackupDestinationSetParameterFTP"}},"anyOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterAmazonS3"},{"$ref":"#/components/schemas/BackupDestinationSetParameterBackblaze"},{"$ref":"#/components/schemas/BackupDestinationSetParameterCustom"},{"$ref":"#/components/schemas/BackupDestinationSetParameterFTP"},{"$ref":"#/components/schemas/BackupDestinationSetParameterGoogleDrive"},{"$ref":"#/components/schemas/BackupDestinationSetParameterLocal"},{"$ref":"#/components/schemas/BackupDestinationSetParameterRsync"},{"$ref":"#/components/schemas/BackupDestinationSetParameterS3Compatible"},{"$ref":"#/components/schemas/BackupDestinationSetParameterSFTP"},{"$ref":"#/components/schemas/BackupDestinationSetParameterWebDAV"}]},"BackupDestinationSetParameterSFTP":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"privatekey":{"type":"string","format":"path","description":"If the `authtype` parameter's value is `key`, the absolute path to the private key file.","example":"/home/backups/key"},"password":{"type":"string","description":"If the `authtype` parameter's value is `password`, the remote server account's password.","example":"123456luggage"},"path":{"type":"string","format":"path","description":"The path to the backups directory on the remote server.","example":"/backups"},"passphrase":{"example":"123456luggage","description":"If the `authtype` parameter's value is `key`, the private key file's passphrase.","type":"string"},"port":{"type":"integer","maximum":"65535","minimum":"1","description":"The remote server's FTP port.","default":"21","example":"21"},"timeout":{"minimum":"30","type":"integer","maximum":"300","description":"The session timeout, in seconds.","default":"30","example":"300"},"username":{"example":"username","description":"The remote server account's username.","type":"string"},"host":{"type":"string","format":"domain","description":"The remote server's hostname.","example":"backups.example.com"},"authtype":{"description":"The authorization type.\n* `password`\n* `key`","example":"password","enum":["password","key"]}},"required":["host","path","username","authtype"],"type":"object"}]},"BackupDestinationSetParameterBackblaze":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"type":"object","required":["application_key","application_key_id","bucket_id","bucket_name"],"properties":{"timeout":{"example":"300","description":"The session timeout, in seconds.","default":"30","minimum":"30","maximum":"300","type":"integer"},"bucket_name":{"description":"The bucket's name.","example":"ChockFullOfNuts","type":"string"},"bucket_id":{"example":"a12b34cd5678e9f","description":"The bucket's ID.","type":"string"},"application_key":{"description":"The application key's name.","example":"A123b45CD678e9","type":"string"},"path":{"type":"string","example":"backups","description":"The path to the backups directory on the remote server.","format":"path"},"application_key_id":{"type":"string","description":"The application key ID that authenticates the Backblaze B2 account.","example":"12a345B678c9"}}}]},"BackupDestinationSetParameterAmazonS3":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"aws_access_key_id":{"description":"The Amazon S3 Access Key ID.","example":"s123456789","type":"string"},"password":{"example":"123456luggage","description":"The Amazon S3 Access Key's password.","type":"string"},"bucket":{"type":"string","description":"The Amazon S3™ bucket.","example":"ChockFullOfNuts"},"timeout":{"example":"300","description":"The session timeout, in seconds.","default":"30","minimum":"30","maximum":"300","type":"integer"},"folder":{"type":"string","default":"","format":"path","description":"The path to the backups directory, relative to the root directory, on the remote server.","example":"subfolder"}},"type":"object","required":["bucket","aws_access_key_id","timeout","password"]}]},"BackupDestinationSetParameterLocal":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"mount":{"type":"integer","description":"Whether the path is mounted.\n* `1` - The path is mounted.\n* `0` - The path is **not** mounted.","default":"0","example":"0","enum":["1","0"]},"path":{"type":"string","example":"/home/backups","description":"The absolute path to the backups directory.","format":"path"},"no_mount_fail":{"type":"integer","example":"0","enum":["1","0"],"description":"Whether to fail the backup attempt if the mount fails.\n* `1` - Fail the backup attempt.\n* `0` - Do **not** fail the backup attempt.","default":"0"}},"type":"object","required":["path"]}]},"BackupDestinationSetParameterS3Compatible":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"folder":{"type":"string","example":"subfolder","default":"","format":"path","description":"The path to the backups directory, relative to the root directory, on the remote server."},"timeout":{"type":"integer","maximum":"300","minimum":"30","default":"30","description":"The session timeout, in seconds.","example":"300"},"host":{"type":"string","example":"www.s3example.com","description":"The S3-compatible provider's server."},"bucket":{"type":"string","description":"The S3-compatible bucket.","example":"ChockFullOfNuts"},"password":{"type":"string","example":"123456luggage","description":"The S3-compatible provider key's password or secret."},"aws_access_key_id":{"type":"string","description":"The S3-compatible provider key ID.","example":"s123456789"}},"required":["host","bucket","aws_access_key_id","timeout","password"],"type":"object"}]},"BackupDestinationSetParameterGoogleDrive":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"client_secret":{"description":"The Google Drive client secret.","example":"aBcde123FgHIjK456","type":"string"},"folder":{"type":"string","description":"The path to the backups directory, relative to the root directory, on the remote server.","format":"path","default":"","example":"subfolder"},"timeout":{"minimum":"30","type":"integer","maximum":"300","default":"30","description":"The session timeout, in seconds.","example":"300"},"client_id":{"description":"The Google Drive client ID.","example":"aBcdeFgHIjK123","type":"string"}},"required":["client_id","client_secret"],"type":"object"}]},"BackupDestinationSetParameterBase":{"properties":{"disabled":{"description":"Whether to disable the backup destination.\n* `1` — Disable the destination.\n* `0` — Enable the destination.\n\n**Note:**\n\nIf you do not set this parameter, the system retains the current setting.","enum":["0","1"],"example":"0","type":"integer"},"type":{"type":"string","enum":["Custom","FTP","Local","SFTP","WebDAV","AmazonS3","Rsync","GoogleDrive","S3Compatible","Backblaze"],"example":"Local","description":"The type of backup destination.\n\n**Note:**\n\nIf you do not set this parameter, the system retains the current setting.\n\nSelect a backup destination from the following menu to view its optional parameters:"},"name":{"example":"destination_name","description":"A new name for the backup destination.\n\n**Note:**\n\nIf you do not set this parameter, the system retains the current setting.","type":"string"},"id":{"example":"0W1ei2rd3A4lI5sT6he7Be8st","description":"The ID of the backup destination to modify.","type":"string"},"disable_reason":{"type":"string","description":"An error message that explains why the backup is disabled.","example":"Could not list files in destination: example"},"only_used_for_logs":{"enum":["0","1"],"example":"1","description":"Whether to use this transport only for logs.\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\n\n**Note:**\n\nIf you do not set this parameter, the system retains the current setting.","type":"integer"},"upload_system_backup":{"type":"integer","description":"Whether to upload system backups.\n* `1` — Upload.\n* `0` — Do **not** upload.\n\n**Note:**\n\nIf you do not set this parameter, the system retains the current setting.","example":"1","enum":["0","1"]}},"required":["id"],"type":"object"},"BackupDestinationSetParameterWebDAV":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"required":["host","path","username","password"],"type":"object","properties":{"password":{"example":"123456luggage","description":"The remote server account's password.","type":"string"},"port":{"type":"integer","maximum":"65535","minimum":"1","description":"The remote server's FTP port.","default":"21","example":"21"},"timeout":{"minimum":"30","maximum":"300","type":"integer","example":"300","description":"The session timeout, in seconds.","default":"30"},"path":{"description":"The path to the backups directory on the remote server.","format":"path","example":"/backups","type":"string"},"ssl":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to use SSL.\n* `1` - Use SSL.\n* `0` - Do **not** use SSL.","default":"1"},"host":{"type":"string","description":"The remote server's hostname.","format":"domain","example":"backups.example.com"},"username":{"description":"The remote server account's username.","example":"username","type":"string"}}}]},"BackupDestinationSetParameterFTP":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"host":{"format":"domain","description":"The remote server's hostname.","example":"backups.example.com","type":"string"},"username":{"example":"username","description":"The remote server account's username.","type":"string"},"password":{"type":"string","example":"123456luggage","description":"The remote server account's password."},"passive":{"type":"integer","example":"1","default":"1","description":"Whether to use passive FTP.\n* `1` - Use passive FTP.\n* `0` - Use active FTP."},"port":{"default":"21","description":"The remote server's FTP port.","example":"21","type":"integer","maximum":"65535","minimum":"1"},"timeout":{"example":"300","default":"30","description":"The session timeout, in seconds.","minimum":"30","maximum":"300","type":"integer"},"path":{"example":"/backups","format":"path","description":"The path to the backups directory on the remote server.","type":"string"}},"required":["host","path","username","password"],"type":"object"}]},"BackupDestinationSetParameterCustom":{"allOf":[{"$ref":"#/components/schemas/BackupDestinationSetParameterBase"},{"properties":{"password":{"type":"string","example":"123456luggage","description":"The remote server account's password."},"path":{"example":"/backups","format":"path","description":"The path to the backups directory on the remote server.","type":"string"},"timeout":{"example":"300","description":"The session timeout, in seconds.","default":"30","maximum":"300","type":"integer","minimum":"30"},"script":{"type":"string","description":"The absolute file path of the user-supplied transport solution script.","format":"path","example":"/home/backups/beammeupscotty.pl"},"username":{"example":"username","description":"The remote server account's username.","type":"string"},"host":{"type":"string","example":"backups.example.com","format":"domain","description":"The remote server's hostname."}},"required":["script","host","path","username","password"],"type":"object"}]}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Destination","description":"Backups / Backup Destination"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"tags":["Backup Destination"],"name":"Backups"}],"paths":{"/backup_destination_set":{"post":{"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"backup_destination_set","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}},"type":"object"}}}}},"description":"Use this function to edit a backup destination's settings.","operationId":"backup_destination_set","summary":"Update backup destination settings","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --input=json --output=jsonpretty \\\n  backup_destination_set\n"},{"lang":"HTTP","label":"HTTP Request (Wire Format)","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"}],"tags":["Backups","Backup Destination"],"requestBody":{"required":"true","description":"The destination settings.","content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/BackupDestinationSetParameterType"}}}}}}}},"get_default_dmarc_record":{"info":{"description":"WHM API.","version":"11.123.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/get_default_dmarc_record":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An object that contains the server's default DMARC record.","properties":{"record":{"type":"string","example":"v=DMARC1; p=none;","description":"The server's default DMARC record string."}},"type":"object"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"description":"The method name called.","example":"get_default_dmarc_record","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"124","parameters":[],"description":"This function retrieves the server's default DMARC record.\n\nThe system uses the default DMARC record when creating new accounts or applying DMARC policies that don't specify a custom record.","operationId":"EmailAuth::get_default_dmarc_record","x-cpanel-api-version":"WHM API 1","summary":"Get the server's default DMARC record","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_default_dmarc_record\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_default_dmarc_record?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}]},"restoreaccount":{"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Account"]}],"paths":{"/restoreaccount":{"get":{"x-cpanel-available-version":"11.28","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","example":"restoreaccount","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"output":{"properties":{"raw":{"type":"string","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 />","description":"An output message that may contain long HTML."}}},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"restoreaccount","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).","parameters":[{"name":"user","in":"query","required":"true","description":"The account's username.","schema":{"example":"username","type":"string"}},{"schema":{"example":"monthly","enum":["monthly","weekly","daily"],"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`","required":"true","name":"type","in":"query"},{"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**.","schema":{"example":"1","enum":["0","1"],"type":"integer"},"name":"all","in":"query","required":"false"},{"required":"false","in":"query","name":"ip","schema":{"type":"integer","enum":["0","1"],"example":"1"},"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."},{"description":"Whether to restore account-level filters (vfilters) and forwarders\n(valiases).\n\n* `1` — Restore.\n* `0` — Do **not** restore.","schema":{"type":"integer","enum":["0","1"],"example":"1"},"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.","required":"false","name":"mysql","in":"query"},{"required":"false","name":"subs","in":"query","schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether to restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Do **not** restore."}],"summary":"Restore account backup","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Account Restoration","Restore Account"]}}},"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"name":"Restore Account","description":"Account Restoration / Restore Account"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2"},"ticket_ssh_test":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"description":"cPanel Support Tickets / Support Access","name":"Support Access"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"tags":["Support Access"],"name":"cPanel Support Tickets"}],"paths":{"/ticket_ssh_test":{"get":{"x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"false","summary":"Validate Customer Portal connection","tags":["Support Tickets","Support Access"],"x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_ssh_test?api.version=1&ticket_id=999999999&server_num=2"}],"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","example":"ticket_ssh_test","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}},"data":{"type":"object","properties":{"non_fatals":{"type":"array","items":{"type":"string","enum":["ticket_system_log_entry","audit_log"],"example":"audit_log"},"description":"A list of non-fatal errors, if any exist.\n\n* `ticket_system_log_entry` — The function could not record the grant operation\nin the ticket.\n* `audit_log` — The function could not record the grant operation in the local\naudit log. The system stores the local audit log in the `/var/cpanel/logs/supportauth/audit.log`\nfile."},"result":{"example":"SUCCESS","description":"The SSH test's result.","type":"string"}}}}}}}}},"description":"This function verifies the connection from the\n[cPanel Customer Portal](https://tickets.cpanel.net/)\nto the server.\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call it as\na request body.","operationId":"ticket_ssh_test","parameters":[{"schema":{"minimum":"1","type":"integer","example":"999999999"},"description":"The ticket's ID number.","required":"true","in":"query","name":"ticket_id"},{"required":"true","in":"query","name":"server_num","schema":{"type":"integer","minimum":"1","example":"2"},"description":"The server's ID number."}]}}}},"get_shared_ip":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"name":"IP Address Management","tags":["IPv4 Address Settings"]}],"paths":{"/get_shared_ip":{"get":{"summary":"Return shared IP address","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_shared_ip\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_shared_ip?api.version=1","label":"URL","lang":"HTTP"}],"tags":["IP Addresses","IPv4 Address Settings"],"responses":{"200":{"description":"HTTP Request was successful.","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":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"get_shared_ip","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}},"x-cpanel-available-version":"62","parameters":[{"in":"query","name":"user","required":"false","description":"The WHM user's username.\n\n**Note:**\n\nThis parameter defaults to the currently-authenticated user.","schema":{"format":"username","example":"example","type":"string"}}],"operationId":"get_shared_ip","description":"This function retrieves the IP address that an account shares with the accounts that it owns."}}},"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"description":"IP Address Management / IPv4 Address Settings","name":"IPv4 Address Settings"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"setresellerips":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"tags":["Account Settings"],"name":"Resellers"}],"paths":{"/setresellerips":{"get":{"tags":["Resellers","Account Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  setresellerips \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellerips?api.version=1&user=username","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Add IP addresses to reseller","parameters":[{"description":"The reseller's username.","schema":{"type":"string","format":"username","example":"username"},"in":"query","name":"user","required":"true"},{"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.","schema":{"type":"string","example":"192.168.0.20","format":"ipv4"},"in":"query","name":"ips","required":"false"},{"required":"false","in":"query","name":"delegate","schema":{"type":"integer","default":"0","example":"1","enum":["1"]},"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."}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"setresellerips","description":"The method name called."}}},"data":{"properties":{"ip":{"items":{"type":"string","example":"192.168.0.20","format":"ipv4"},"description":"An array of the reseller's allocated IP addresses.","type":"array"},"all":{"enum":["1"],"example":"1","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.","type":"integer"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"name":"Account Settings","description":"Resellers / Account Settings"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"resellerstats":{"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"name":"Account Settings","description":"Resellers / Account Settings"}],"paths":{"/resellerstats":{"get":{"operationId":"resellerstats","description":"This function lists data about a reseller's accounts.","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"username","format":"username"},"description":"The reseller's username."},{"required":"false","name":"filter_deleted","in":"query","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"},"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."},{"required":"false","name":"filter_suspended","in":"query","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"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."},{"description":"The month to query, in numeric format.\n\nThis parameter defaults to the current month.","schema":{"type":"integer","maximum":"12","minimum":"1","example":"2"},"in":"query","name":"month","required":"false"},{"required":"false","name":"year","in":"query","schema":{"type":"integer","example":"2019"},"description":"The year to query, in numeric format.\n\nThis parameter defaults to the current year."}],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"reseller":{"type":"object","properties":{"user":{"example":"username","format":"username","description":"The reseller account's username.","type":"string"},"bwoverselling":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the reseller can oversell bandwidth.\n\n* `1` — The reseller can oversell bandwidth.\n* `0` — The reseller **cannot** oversell bandwidth."},"totalbwused":{"type":"string","example":"0","description":"The total amount of bandwidth that the reseller's accounts have used, in megabytes (MB), encoded as a string."},"totaldiskalloc":{"type":"string","example":"1100","description":"The total amount of disk space that the reseller has given to its accounts, in megabytes (MB), encoded as a string."},"diskoverselling":{"type":"integer","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"},"diskquota":{"minimum":"0","type":"integer","example":"0","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."},"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":{"type":"object","properties":{"domain":{"description":"The account's main domain.","format":"domain","example":"example1.com","type":"string"},"bandwidthused":{"type":"string","example":"0","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)."},"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"},"deleted":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the account has been deleted.\n\n* `1` — Deleted.\n* `0` — **Not** deleted."},"suspended":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the account is suspended.\n\n* `1` — Suspended.\n* `0` — Not suspended."},"user":{"type":"string","format":"username","description":"The account's username.","example":"example1"},"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"},"bandwidthlimit":{"example":"500","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.","type":"string"},"package":{"type":"string","example":"default","description":"The account's hosting plan (package)."}}},"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","type":"integer","minimum":"0"},"month":{"description":"The current month or a queried month.","example":"2","type":"integer","maximum":"12","minimum":"1"},"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"},"year":{"example":"2019","description":"The current year or a queried year.","type":"integer"},"totalbwalloc":{"type":"string","example":"500","description":"The total amount of bandwidth that the reseller has given to its accounts, in megabytes (MB), encoded as a string."}},"description":"Object containing data about a reseller account."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"resellerstats","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  resellerstats \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/resellerstats?api.version=1&user=username","label":"URL","lang":"HTTP"}],"tags":["Resellers","Account Settings"],"summary":"Return reseller's information","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Account Settings"],"name":"Resellers"}],"openapi":"3.0.2","info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"modsec_add_rule":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_add_rule":{"get":{"parameters":[{"required":"true","in":"query","name":"config","schema":{"example":"modsec2.user.conf","type":"string"},"description":"The ModSecurity configuration file."},{"name":"rule","in":"query","required":"true","description":"The rule's text.","schema":{"example":"SecAction \"phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/\"","type":"string"}}],"operationId":"modsec_add_rule","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","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.","type":"object","properties":{"disabled":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether the rule is disabled.\n- 1  Disabled.\n- 0  Enabled."},"staged":{},"vendor_active":{},"vendor_id":{},"id":{"description":"The ModSecurity rule's ID. A valid ModSecurity rule ID.","example":"168","type":"integer"},"duplicate":{"type":"integer","description":"Whether the rule already exists in the ModSecurity configuration staging file.\n- 1  Exists.\n- 0  Does not exist.","example":"0","enum":["0","1"]},"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"},"config":{},"meta_msg":{"type":"string","description":"The ModSecurity rule's description. A valid string.","example":"Example rule message"},"config_active":{}}}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"modsec_add_rule","description":"The method name called.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.46","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"}],"tags":["ModSecurity","Rule Settings"],"summary":"Add staged ModSecurity rule","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"disable_cphulk":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"tags":["Settings"],"name":"Login Security (cPHulk)"}],"paths":{"/disable_cphulk":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","example":"disable_cphulk","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details.","enum":["0","1"],"example":"1"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[],"operationId":"disable_cphulk","description":"This function disables the cPHulk service.","summary":"Disable login security","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  disable_cphulk\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_cphulk?api.version=1","lang":"HTTP","label":"URL"}],"tags":["cPHulk","Settings"]}}},"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"name":"Settings","description":"Login Security (cPHulk) / Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"rename_postgresql_database":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"PostgreSQL Databases","description":"Databases / PostgreSQL Databases"}],"paths":{"/rename_postgresql_database":{"get":{"summary":"Update PostgreSQL database name","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  rename_postgresql_database \\\n  oldname='database' \\\n  newname='database2'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_postgresql_database?api.version=1&oldname=database&newname=database2"}],"tags":["Databases","PostgreSQL Databases"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","description":"The method name called.","example":"rename_postgresql_database"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[{"name":"oldname","in":"query","required":"true","description":"The database's current name.","schema":{"type":"string","example":"database"}},{"schema":{"example":"database2","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.","required":"true","name":"newname","in":"query"},{"name":"cpuser","in":"query","required":"false","description":"The database's owner.","schema":{"type":"string","example":"username","format":"username"}}],"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"}}},"x-tagGroups":[{"name":"Databases","tags":["PostgreSQL Databases"]}]},"get_tweaksetting":{"paths":{"/get_tweaksetting":{"get":{"summary":"Return Tweak Settings option's value","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_tweaksetting \\\n  key='defaultmailaction'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_tweaksetting?api.version=1&key=defaultmailaction","lang":"HTTP","label":"URL"}],"tags":["Configurations"],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","description":"The method name called.","example":"get_tweaksetting"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}},"data":{"properties":{"tweaksetting":{"type":"object","properties":{"value":{"type":"string","example":"localuser","description":"The value. This value depends on the `key` value's requirements."},"key":{"description":"A key name in the `cpanel.config` file.","example":"defaultmailaction","type":"string"}},"description":"A list of the *Tweak Settings* option's information."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function retrieves values from the\n[`/var/cpanel/cpanel.config`](https://go.cpanel.net/ThecpanelconfigFile)\nfile and the server's [Exim configuration](https://go.cpanel.net/whmdocsEximConfigurationManager).","operationId":"get_tweaksetting","parameters":[{"schema":{"example":"defaultmailaction","type":"string"},"description":"The [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) option.","required":"true","name":"key","in":"query"},{"required":"false","in":"query","name":"module","schema":{"type":"string","example":"Main","enum":["Apache","Basic","Mail","Main"],"default":"Main"},"description":"One of the following *Tweak Settings* module names:\n* `Apache`\n* `Basic`\n* `Mail`\n* `Main`"}]}}},"x-tagGroups":[{"tags":["Configurations"],"name":"Server Administration"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Configurations","description":"Server Administration / Configurations"}],"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"ticket_update_service_agreement_approval":{"paths":{"/ticket_update_service_agreement_approval":{"get":{"x-cpanel-api-version":"WHM API 1","x-cpanel-cli-support":"false","summary":"Enable Technical Support Agreement acceptance","tags":["Support Tickets","Ticket Management"],"x-codeSamples":[{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_update_service_agreement_approval?api.version=1&version=2020-04.v01.TSUPPORT","label":"URL","lang":"HTTP"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"ticket_update_service_agreement_approval","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}}}},"x-cpanel-available-version":"60","parameters":[{"description":"The version of the TSA that the user approved.","schema":{"type":"string","example":"2020-04.v01.TSUPPORT"},"name":"version","in":"query","required":"true"}],"operationId":"ticket_update_service_agreement_approval","description":"This function records a user's acceptance of the Technical Support\nAgreement (TSA). The cPanel Customer Portal stores each record with the user's\nlogin, the date and time, and the TSA's version.\n\n**Note:**\n\nThis function is **not** available through the command line.\nYou **must** call it as a request body."}}},"x-tagGroups":[{"tags":["Ticket Management"],"name":"cPanel Support Tickets"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"name":"Ticket Management","description":"cPanel Support Tickets / Ticket Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"set_application_contact_importance":{"x-tagGroups":[{"name":"Server Administration","tags":["Notifications"]}],"paths":{"/set_application_contact_importance":{"get":{"x-cpanel-available-version":"58","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"set_application_contact_importance","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"operationId":"set_application_contact_importance","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.","parameters":[{"schema":{"type":"string","example":"Check"},"description":"The cPanel & WHM application module's name.","required":"true","in":"query","name":"app"},{"name":"importance","in":"query","required":"true","description":"The importance level at which to send the notification.\n\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`","schema":{"enum":["High","Medium","Low","Disabled"],"example":"Disabled","type":"string"}}],"summary":"Update app contact importance setting","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  set_application_contact_importance \\\n  app='Check' \\\n  importance='Disabled'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_application_contact_importance?api.version=1&app=Check&importance=Disabled","label":"URL","lang":"HTTP"}],"tags":["Server Administration","Notifications"]}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Notifications","name":"Notifications"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"reboot":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"name":"Server Administration","tags":["System Information"]}],"paths":{"/reboot":{"get":{"parameters":[{"schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"},"description":"Whether to use a forceful reboot.\n* `1` - Use a forceful reboot.\n* `0` - Do **not** use a forceful reboot.\n\n**Warning:**\n\n A forceful reboot may result in data loss if active processes exist on the server.","required":"false","in":"query","name":"force"}],"operationId":"reboot","description":"This function reboots the server.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","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"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"reboot","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","tags":["Server Administration","System Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  reboot\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/reboot?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Restart server"}}},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"System Information","description":"Server Administration / System Information"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}]},"listsuspended":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Suspensions","description":"Accounts / Suspensions"}],"paths":{"/listsuspended":{"get":{"parameters":[],"description":"This function lists suspended accounts on the server.","operationId":"listsuspended","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"account":{"description":"A list of objects containing suspended account data.","items":{"properties":{"time":{"type":"string","example":"Thu Nov 18 10:34:34 2014","description":"The current date and time in `Day Mon DD HH:mm:SS YYYY` human-readable format, where:\n* `Day` - represents the day of the week as a three-letter abbreviation.\n* `Mon` - represents the month's three-letter abbreviation.\n* `DD` - represents the date.\n* `HH` - represents the hour.\n* `mm` - represents the minute.\n* `SS` - represents the second.\n* `YYYY` - represents the year."},"unixtime":{"type":"integer","example":"1416306874","description":"The current date and time.","format":"unix_timestamp"},"reason":{"type":"string","description":"The reason why the account is suspended, if one exists.","example":"Suspended for nonpayment."},"user":{"type":"string","example":"username","description":"The cPanel account's username."},"is_locked":{"description":"Whether the account is locked.\n* `1` - Locked.\n* `0` - Not locked.","enum":["0","1"],"example":"0","type":"integer"},"owner":{"description":"The cPanel account's owner.\n- `root`\n- A reseller's username.\n- The account's username.","example":"root","type":"string"}},"type":"object"},"type":"array"}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"command":{"description":"The method name called.","example":"listsuspended","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11","tags":["Suspensions"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  listsuspended\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listsuspended?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return suspended cPanel accounts and information"}}},"x-tagGroups":[{"name":"Accounts","tags":["Suspensions"]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"assign_account_enhancement":{"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Account Enhancements module for WHM.","name":"Account Enhancements"}],"paths":{"/assign_account_enhancement":{"get":{"tags":["Account Enhancements"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  assign_account_enhancement \\\n  account='username' \\\n  name='enhancement 5000'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/assign_account_enhancement?api.version=1&account=username&name=enhancement%205000","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Assign Account Enhancement","description":"This function assigns an Account Enhancement to a cPanel account.","operationId":"assign_account_enhancement","parameters":[{"description":"The username of the account.","schema":{"type":"string","format":"username","example":"username"},"name":"account","in":"query","required":"true"},{"description":"The name of the account enhancement.","schema":{"type":"string","example":"enhancement 5000"},"name":"name","in":"query","required":"true"}],"x-cpanel-available-version":"11.98","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"assign_account_enhancement","description":"The method name called."},"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"}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"tags":["Account Enhancements"],"name":"Accounts"}]},"get_autossl_metadata":{"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"paths":{"/get_autossl_metadata":{"get":{"summary":"Return current user's AutoSSL metadata","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_autossl_metadata\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_metadata?api.version=1"}],"tags":["SSL","Auto-Generated Certificates"],"x-cpanel-available-version":"60","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An object containing the user's AutoSSL metadata key values.","properties":{"notify_autossl_expiry_coverage_user":{"enum":["0","1"],"example":"1","description":"This option will send a notification if at least\none of a user's currently-secured domains will lose\ncoverage when the certificate renews.\n\n* `1` - Notify.\n* `0` - Do **not** notify.","type":"integer"},"notify_autossl_renewal_coverage_reduced_user":{"enum":["0","1"],"example":"1","description":"This option will send a notification when AutoSSL\nhas renewed a certificate for a user and the new certificate\nlacks at least one domain that the previous certificate\nsecured.\n\n* `1` - Notify.\n* `0` - Do **not** notify.","type":"integer"},"notify_autossl_expiry":{"description":"This option will send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate.\n\n**Note:**\n\nThis can happen if all of a websites domains fail Domain Control Validation (DCV), or if the AutoSSL provider has not issued a certificate in response to a request.\n* `1` -  Notify.\n* `0` -  Do **not** notify.","example":"1","enum":["0","1"],"type":"integer"},"notify_autossl_renewal_coverage_reduced":{"type":"integer","example":"1","enum":["0","1"],"description":"This option will send a notification when AutoSSL\nhas renewed a certificate and the new certificate lacks\nat least one domain that the previous certificate secured.\n\n\n* `1` - Notify.\n* `0` - Do **not** notify."},"clobber_externally_signed":{"type":"integer","example":"1","enum":["0","1"],"description":"This option will allow AutoSSL to replace certificates that none of this systems AutoSSL modules issued.\nWhen 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.\n* `1` - Replace the certificate.\n* `0` - Do **not** replace the certificate."},"notify_autossl_renewal":{"type":"integer","description":"This option will send a notification when AutoSSL\nsuccessfully renews a certificate.\n\n* `1` - Notify.\n* `0` - Do **not** notify.","example":"1","enum":["0","1"]},"notify_autossl_renewal_coverage":{"type":"integer","description":"This option will send a notification if a currently-secured\ndomain fails DCV and the certificate has not reached its\nrenewal period.\n\n* `1` -  Notify.\n* `0` -  Do **not** notify.","example":"1","enum":["0","1"]},"notify_autossl_renewal_user":{"description":"This option will send a notification when AutoSSL\nsuccessfully renews a certificate for a user.\n\n* `1` - Notify\n* `0` - Do **not** notify.","enum":["0","1"],"example":"1","type":"integer"},"notify_autossl_renewal_uncovered_domains_user":{"type":"integer","description":"This option will send a notification when AutoSSL\nhas renewed a certificate for a user and the new certificate\nlacks one or more of the websites domains.\n\n* `1` - Notify.\n* `0` - Do **not** notify.","example":"1","enum":["0","1"]},"notify_autossl_expiry_coverage":{"type":"integer","example":"1","enum":["0","1"],"description":"This option will send a notification if at least one currently-secured domain will lose coverage when the certificate renews.\n\n* `1` -  Notify.\n* `0` -  Do **not** notify."},"notify_autossl_renewal_uncovered_domains":{"description":"This option will send a notification when AutoSSL\nhas renewed a certificate and the new certificate lacks\none or more of the websites domains.\n\n* `1` - Notify.\n* `0` - Do **not** notify.","example":"1","enum":["0","1"],"type":"integer"},"notify_autossl_renewal_coverage_user":{"type":"integer","description":"This option will send a notification if a currently-secured\ndomain fails DCV and the certificate has not reached its\nrenewal period.\n\n* `1` - Notify.\n* `0` - Do **not** notify."},"notify_autossl_expiry_user":{"type":"integer","description":"This option will send a notification when a\nuser's AutoSSL certificate expires. This occurs when\nAutoSSL cannot request a new certificate for a user.\n\n* `1` - Notify.\n* `0` - Do **not** notify.","enum":["0","1"],"example":"1"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","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."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"type":"string","description":"The method name called.","example":"get_autossl_metadata"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}},"type":"object"}}}}},"description":"This function retrieves values for the currently authenticated user's AutoSSL's metadata keys.","operationId":"get_autossl_metadata","parameters":[]}}},"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"remote_mysql_monitor_profile_activation":{"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"description":"Databases / Remote MySQL Databases","name":"Remote MySQL Databases"}],"paths":{"/remote_mysql_monitor_profile_activation":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_monitor_profile_activation\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_monitor_profile_activation?api.version=1"}],"tags":["Databases","Remote MySQL Databases"],"summary":"Return remote MySQL profile activation","x-cpanel-api-version":"WHM API 1","parameters":[],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"job_in_progress":{"type":"object","properties":{"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.","example":"INPROGRESS","enum":["DONE","INPROGRESS","FAILED"],"type":"string"},"profile_name":{"type":"string","example":"remote_server","description":"The the name of the activated profile."},"start_time":{"type":"integer","description":"The time when the job started.","format":"unix_timestamp","example":"1432064519"},"steps":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","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","enum":["DONE","INPROGRESS","FAILED"]},"start_time":{"description":"The time when the process began.","format":"unix_timestamp","example":"1432064519","type":"integer"},"name":{"type":"string","example":"Updating /root/.my.cnf","description":"The name of the process."},"end_time":{"type":"integer","format":"unix_timestamp","description":"The time when the process finished.","example":"1432064520"}}},"description":"An array of objects containing the completed or active processes for the current profile activation."}},"description":"An object containing the profile activation that is currently in progress."},"last_job_details":{"properties":{"end_time":{"type":"integer","example":"1432220941","description":"The time when the job finished.","format":"unix_timestamp"},"profile_name":{"type":"string","example":"MyProfile","description":"The the name of the activated profile."},"status":{"type":"string","example":"DONE","enum":["DONE","INPROGRESS","FAILED"],"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."},"start_time":{"type":"integer","description":"The time when the job started.","format":"unix_timestamp","example":"1432064519"},"steps":{"items":{"properties":{"name":{"description":"The name of the process.","type":"string"},"end_time":{"example":"1432220941","format":"unix_timestamp","description":"The time when the process finished.","type":"integer"},"status":{"type":"string","example":"DONE","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."},"start_time":{"type":"integer","description":"The time when the process began.","format":"unix_timestamp","example":"1432220941"}},"type":"object"},"description":"An array of objects containing the completed processes for the most recent profile activation.","type":"array"}},"type":"object","description":"An object containing the most recently completed profile activation's data."}}},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"remote_mysql_monitor_profile_activation","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.52"}}},"x-tagGroups":[{"tags":["Remote MySQL Databases"],"name":"Databases"}],"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"participate_in_analytics":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"tags":[{"name":"cPanel Analytics","description":"The cPanel Analytics module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"name":"Server Administration","tags":["cPanel Analytics"]}],"paths":{"/participate_in_analytics":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/participate_in_analytics?api.version=1&enabled=1"}],"x-cpanel-available-version":"78","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"participate_in_analytics","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"operationId":"participate_in_analytics","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).","parameters":[{"required":"true","in":"query","name":"enabled","schema":{"enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to enable Interface Analytics.\n\n* `1` — Enable.\n* `0` — Disable."}]}}}},"deletesshkey":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Authentication","tags":["SSH Keys and Connections"]}],"paths":{"/deletesshkey":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/deletesshkey?api.version=1&file=%2froot%2f.ssh%2ftest","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"deletesshkey"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"type":"object","properties":{"file":{"type":"string","description":"The SSH key file's name.","example":"/root/.ssh/test"}}}},"type":"object"}}}}},"operationId":"deletesshkey","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.","parameters":[{"required":"true","in":"query","name":"file","schema":{"type":"string","example":"/root/.ssh/test"},"description":"The SSH key file's name."},{"in":"query","name":"leave_authorized","required":"false","description":"Whether to authorize the SSH key to access the server.\n\n* `1` — Leave authorized.\n* `0` — Do **not** leave authorized.","schema":{"type":"integer","default":"1","example":"0","enum":["0","1"]}}]}}},"tags":[{"name":"SSH Keys and Connections","description":"Authentication / SSH Keys and Connections"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"delpkgext":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Hosting Plan Extensions"],"name":"Hosting Plans"}],"paths":{"/delpkgext":{"get":{"tags":["Packages","Hosting Plan Extensions"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delpkgext \\\n  name='package1' \\\n  _DELETE_EXTENSIONS='extension1 extension2'\n","label":"CLI","lang":"Shell"},{"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","summary":"Remove hosting plan extension","parameters":[{"description":"The hosting plan's name.","schema":{"type":"string","example":"package1"},"in":"query","name":"name","required":"true"},{"schema":{"example":"extension1 extension2","type":"string"},"explode":"true","description":"The space delimited\n[package extensions](https://go.cpanel.net/GuidetoPackageExtensions)\nto delete.\n\n**Note:**\n\n* Extension names are case-sensitive.","style":"spaceDelimited","required":"true","name":"_DELETE_EXTENSIONS","in":"query"}],"operationId":"delpkgext","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"pkg":{"type":"string","description":"The deleted hosting plan's name.","example":"package1"}}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"command":{"description":"The method name called.","example":"delpkgext","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"68"}}},"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"name":"Hosting Plan Extensions","description":"Hosting Plans / Hosting Plan Extensions"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}]},"cpgreylist_status":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/cpgreylist_status":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"is_exim_enabled":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether Exim is enabled.\n* `1` — Enabled.\n* `0` — Disabled."},"is_enabled":{"example":"1","enum":["0","1"],"description":"Whether Greylisting is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"service":{"example":"cPGreyList","description":"The name of the service.","type":"string"}}},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"cpgreylist_status"},"reason":{"type":"string","example":"OK","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."}}}}}}}}},"x-cpanel-available-version":"11.50","parameters":[],"description":"This function returns the status of Greylisting.","operationId":"cpgreylist_status","summary":"Return Greylisting status","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_status\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_status?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Greylisting","Spam Protection (Greylisting)"]}}},"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}]},"set_autossl_user_excluded_domains":{"paths":{"/set_autossl_user_excluded_domains":{"get":{"x-cpanel-available-version":"66","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"set_autossl_user_excluded_domains","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"set_autossl_user_excluded_domains","description":"This function disables AutoSSL for a specific domain on an account.\n\n**Warning:**\n\n  This function **replaces** the list of any previously-excluded domains. To add a domain to the list of the user's excluded domains, use the `add_autossl_user_excluded_domains` function.","parameters":[{"required":"true","name":"username","in":"query","schema":{"example":"example","format":"username","type":"string"},"description":"The cPanel user's account."},{"name":"domain","in":"query","required":"false","description":"Disable AutoSSL for this domain. If you do **not** include this parameter, the system will **enable** AutoSSL for every domain on the account.\n\n**Note**\n\nTo disable AutoSSL for multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:\n* Use the `domain` parameter multiple times.\n* Use the `domain`, `domain-1`, and `domain-2` parameters.","examples":{"multiple-alternative":{"summary":"Multiple domains","value":"domain=example.com&domain=example1.com&domain=example2.com"},"multiple":{"value":"domain=example.com&domain-1=example1.com&domain-2=example2.com","summary":"Multiple domains"},"single":{"value":"example.com","summary":"A single domain."}},"schema":{"example":"cpcalendars.example.com","format":"domain","type":"string"}}],"summary":"Disable AutoSSL for domain","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  set_autossl_user_excluded_domains \\\n  username='example'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_user_excluded_domains?api.version=1&username=example","label":"URL","lang":"HTTP"}],"tags":["SSL","Auto-Generated Certificates"]}}},"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"parse_dns_zone":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"ResponseComment":{"allOf":[{"$ref":"#/components/schemas/ResponseControlOrComment"}],"title":"Comment"},"ResponseControl":{"allOf":[{"$ref":"#/components/schemas/ResponseControlOrComment"}],"title":"Control"},"Payload":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ResponseRR"},{"$ref":"#/components/schemas/ResponseControl"},{"$ref":"#/components/schemas/ResponseComment"}],"discriminator":{"propertyName":"type","mapping":{"control":"#/components/schemas/ResponseControl","record":"#/components/schemas/ResponseRR","comment":"#/components/schemas/ResponseComment"}}},"description":"The zone’s content."},"ResponseBase":{"properties":{"line_index":{"type":"integer","minimum":"0","description":"The line’s index in the zone file.","example":"22"},"type":{"type":"string","enum":["record","control","comment"],"description":"The type of object in the zone file:\n\n* `record` - A resource record.\n* `control` - A control statement.\n* `comment` - A line comment."}},"type":"object"},"ResponseControlOrComment":{"allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"text_b64":{"type":"string","description":"The line’s text, encoded to base64.","format":"base64","example":"OyBab25lIGZpbGUgZm9yIHRleGFzLmNvbQ=="}}}]},"ResponseRR":{"title":"Resource Record","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"data_b64":{"type":"array","description":"The resource record’s content, encoded to base64.","items":{"example":"dGV4YXMuY29tLg==","format":"base64","type":"string"}},"record_type":{"example":"MX","description":"The resource record’s type.","type":"string"},"dname_b64":{"type":"string","format":"base64","description":"The resource record’s owner, encoded to base64. A base64-decoded owner that lacks a trailing period (`.`) is a subdomain of the zone.","example":"dGV4YXMuY29tLg=="},"ttl":{"type":"integer","minimum":"0","example":"14400","description":"The resource record’s TTL (Time-to-Live)."}}}]}}},"openapi":"3.0.2","info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"DNS Zones","description":"DNS / DNS Zones"}],"paths":{"/parse_dns_zone":{"get":{"x-codeSamples":[{"source":"whmapi1 parse_dns_zone zone='example.com'","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/parse_dns_zone?api.version=1&zone=example.com","label":"URL","lang":"HTTP"}],"tags":["DNS","DNS Zones"],"summary":"Return a parsed DNS zone","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","in":"query","name":"zone","schema":{"example":"example.com","type":"string"},"description":"The name of one of the user’s DNS zones."}],"description":"This function parses a given DNS zone.\n\n**Important:**\n\nMost DNS zones contain only 7-bit ASCII. However, it is possible for\nDNS zones to contain any binary sequence. An application that decodes\nthis function's base64 output **must** be able to handle cases\nwhere the decoded octets do not match any specific character\nencoding.","operationId":"parse_dns_zone","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"parse_dns_zone","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"payload":{"$ref":"#/components/schemas/Payload"}},"type":"object"}}}}}}},"x-cpanel-available-version":"96"}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Zones"]}]},"editzonerecord":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"schemas":{"DnsEditZoneParameterType":{"discriminator":{"propertyName":"type","mapping":{"AAAA":"#/components/schemas/DnsEditZoneParameterTypeAAAA","TXT":"#/components/schemas/DnsEditZoneParameterTypeTXT","CNAME":"#/components/schemas/DnsEditZoneParameterTypeCNAME","DNAME":"#/components/schemas/DnsEditZoneParameterTypeDNAME","CAA":"#/components/schemas/DnsEditZoneParameterTypeCAA","HINFO":"#/components/schemas/DnsEditZoneParameterTypeHINFO","NS":"#/components/schemas/DnsEditZoneParameterTypeNS","RP":"#/components/schemas/DnsEditZoneParameterTypeRP","PTR":"#/components/schemas/DnsEditZoneParameterTypePTR","A6":"#/components/schemas/DnsEditZoneParameterTypeA6","DS":"#/components/schemas/DnsEditZoneParameterTypeDS","AFSDB":"#/components/schemas/DnsEditZoneParameterTypeAFSDB","ALIAS":"#/components/schemas/DnsEditZoneParameterTypeALIAS","SRV":"#/components/schemas/DnsEditZoneParameterTypeSRV","MX":"#/components/schemas/DnsEditZoneParameterTypeMX","A":"#/components/schemas/DnsEditZoneParameterTypeA","LOC":"#/components/schemas/DnsEditZoneParameterTypeLOC","SOA":"#/components/schemas/DnsEditZoneParameterTypeSOA"}},"anyOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterTypeA"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeA6"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeAAAA"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeAFSDB"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeALIAS"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeCAA"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeCNAME"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeDNAME"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeDS"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeHINFO"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeLOC"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeMX"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeNS"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypePTR"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeRP"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeSOA"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeSRV"},{"$ref":"#/components/schemas/DnsEditZoneParameterTypeTXT"}]},"DnsEditZoneParameterTypeDNAME":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"required":["dname"],"type":"object","properties":{"dname":{"example":"hostname.example.com","format":"domain","description":"The delegation name (DNAME) alias.\n\n**Note:**\n\nFor more information about DNAME records, read [RFC 2672 at IANA](http://tools.ietf.org/html/rfc2672).","type":"string"}}}]},"DnsEditZoneParameterTypeAFSDB":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"hostname":{"format":"domain","description":"The database servers' hostname.","example":"hostname.example.com","type":"string"},"subtype":{"type":"integer","example":"1","description":"The 16-bit integer of an AFS cell type.\n\nFor example, specify `1` to signify an AFS version 3.0 Volume Location Server.\n\n**Note:**\n\n* You **must** uuencode the colons (`:`) in IPv6 addresses in your function calls.\n* For more information about AFSDB records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183)."}},"type":"object","required":["subtype","hostname"]}]},"DnsEditZoneParameterTypeALIAS":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"alias":{"example":"hostname.example.com","format":"domain","description":"The hostname you want to point to.\n\n**Note:**\n\nWe strongly recommend that you do not use this function.\nUsing the ALIAS DNS record may result in unexpected behavior, including website downtimes outside of your control, inconsistency in the handling of the record, and security vulnerabilities.\nThis record is only available if you enable access to it and use PowerDNS.","type":"string"}},"required":["alias"],"type":"object"}]},"DnsEditZoneParameterTypeCNAME":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"flatten_to":{"description":"The IP address that the specified CNAME will resolve to.\n\n**Note:**\n\nYou **must** use the `flatten` parameter with this parameter.","oneOf":[{"format":"ipv4","description":"A valid IPv4 address.","example":"192.0.2.27","type":"string"},{"description":"A valid IPv6 address.","format":"ipv6","example":"2001:0db8:85a3:0042:1000:8a2e:0370:7334","type":"string"}]},"cname":{"type":"string","example":"hostname.example.com","description":"The canonical name (CNAME) alias.\n\n**Note:**\n\nFor more information about CNAME records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"domain"},"flatten":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether to resolve the specified CNAME value with the record's IP address.\n\nIf you do **not** also set the `flatten_to` parameter, the system will attempt to resolve the CNAME automatically.\n\n* `1` - Flattened.\n* `0` - Not flattened (the function will **fail**).\n\n**Note:**\n\nOnly use this parameter when you alter the zone's `root` record."}},"type":"object","required":["cname"]}]},"DnsEditZoneParameterTypePTR":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"ptrdname":{"type":"string","description":"A pointer to a canonical name (CNAME).\n\n**Note:**\n\n* Do **not** omit any necessary trailing periods.\n* For more information about PTR records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"domain","example":"hostname.example.com"}},"type":"object"}]},"DnsEditZoneParameterTypeA6":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"refer":{"example":"0::0","description":"The record's address suffix.\n\n**Note:**\n\nYou **must** uuencode the colons (`:`) in IPv6 addresses in your function calls.","deprecated":"true","type":"string"},"prefix":{"minimum":"1","type":"integer","description":"The record's prefix length.","example":"48","deprecated":"true"}},"required":["prefix","refer"],"type":"object","description":"\nA6 records are **deprecated**. We **strongly** recommend that you use AAAA records to\nstore IPv6 addresses."}]},"DnsEditZoneParameterTypeRP":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"mbox":{"description":"The Responsible Person's (RP) email address.\n\n**Note:**\n\n* Replace the `@` symbol with a period (`.`).\n* Do **not** omit any necessary trailing periods.\n* For more information about RP records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183).","example":"user.example.com.","type":"string"},"txtdname":{"type":"string","format":"domain","description":"The RP's domain name.\n\n**Note:**\n\nDo **not** omit any necessary trailing periods.","example":"mx1.host.example.com."}},"type":"object"}]},"DnsEditZoneParameterTypeSOA":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"refresh":{"type":"integer","minimum":"1","example":"1440","description":"The amount of time, in seconds, to wait before the secondary DNS server queries the primary DNS server's SOA records for changes."},"mname":{"example":"ns1.host.example.com","description":"The domain's authoritative nameserver.","format":"domain","type":"string"},"rname":{"example":"email.host.example.com","description":"The Responsible Person's (RP) email address.\n\n**Note:**\n\n* Replace the `@` symbol with a period (`.`).\n* Do **not** omit any necessary trailing periods.","type":"string"},"expire":{"type":"integer","minimum":"1","description":"The amount of time, in seconds, to wait before the secondary server attempts to complete a zone transfer.","example":"3600000"},"retry":{"type":"integer","minimum":"1","description":"The amount of time, in seconds, to wait before the secondary server retries a failed zone transfer.","example":"14400"},"lines":{"minimum":"1","type":"integer","example":"4","description":"The number of lines in the SOA section."},"serial":{"description":"The zone file's revision number.\n\n**Note:**\n\nFor more information about SOA records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"2013122501","type":"integer"}},"type":"object"}]},"DnsEditZoneParameterTypeLOC":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"type":"object","properties":{"version":{"example":"0","enum":["0"],"description":"The record's version number.\n\n**Note:**\n\n* You **must** set this value to `0`.\n* For more information about LOC records, read [RFC 1876 at IANA](http://tools.ietf.org/html/rfc1876).","type":"integer"},"vert_pre":{"description":"The location's vertical precision distance, in meters.","example":"10","minimum":"1","type":"integer"},"longitude":{"example":"47.95 W","description":"The location's longitude.","type":"string"},"altitude":{"type":"string","example":"178m","description":"The location's altitude above sea level, in meters.\n\n**Note:**\n\nMake certain that you append `m` to the altitude value."},"size":{"type":"integer","minimum":"1","description":"The diameter of a sphere that encloses the entire location, in meters.","example":"10"},"horiz_pre":{"minimum":"1","type":"integer","example":"10","description":"The location's horizontal precision distance, in meters."},"latitude":{"type":"string","description":"The location's latitude.","example":"54.305 N"}}}]},"DnsEditZoneParameterTypeA":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"type":"object","required":["address"],"properties":{"address":{"format":"ipv4","description":"The zone record's IPv4 address.\n\n**Note:**\n\nFor more information about A records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"192.168.0.20","type":"string"}}}]},"DnsEditZoneParameterTypeDS":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"type":"object","properties":{"digtype":{"type":"integer","description":"The record's digest type.\n\n* `1` — SHA-1\n* `2` — SHA-256\n* `4` — SHA-384","example":"1","enum":["1","2","4"]},"algorithm":{"type":"integer","description":"The record's algorithm number.\n\n* `1` - RSAMD5\n* `2` - Diffie-Hellman\n* `3` - DSA/SHA-1\n* `4` - Elliptic Curve\n* `5` - RSA/SHA-1\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* `252` - Indirect\n* `253` - Private DNS\n* `254` - Private OID","example":"5","enum":["1","2","3","4","5","7","8","10","13","14","252","253","254"]},"keyname":{"type":"integer","description":"The record's KeyTag value.\n\n**Note:**\n\nFor more information about DS records, read [RFC 4034 at IANA](http://tools.ietf.org/html/rfc4034).","example":"2642"}}}]},"DnsEditZoneParameterTypeAAAA":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"address":{"example":"2001:1:42:1::2a","description":"The zone record's IPv6 address.\n\n**Note:**\n\n* You **must** uuencode the colons (`:`) in IPv6 addresses in your function calls.\n* For more information about AAAA records, read [RFC 3596 at IANA](http://tools.ietf.org/html/rfc3596).","format":"ipv6","type":"string"}},"type":"object","required":["address"]}]},"DnsEditZoneParameterTypeNS":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"nsdname":{"example":"ns1.example.com","format":"domain","description":"The domain's authoritative nameserver.\n\n**Note:**\n\nFor more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","type":"string"}},"type":"object"}]},"DnsEditZoneParameterBase":{"type":"object","required":["domain","line","ttl"],"properties":{"ttl":{"description":"The record's Time To Live (TTL), in seconds.","example":"86400","minimum":"1","type":"integer"},"name":{"example":"hostname.example.com.","format":"domain","description":"The record's name.\n\nIf you do not use this parameter, the system retains the current setting.\n\n**Note:**\n\nDo **not** omit any necessary trailing periods.\n\nYou **cannot** use this function to modify temporary domains.","type":"string"},"class":{"example":"IN","description":"The record's class.\n\nIf you do not use this parameter, the system retains the current setting.","oneOf":[{"enum":["IN"],"type":"string"},{"type":"string","description":"A valid DNS record class."}]},"line":{"type":"integer","minimum":"1","example":"24","description":"The zone record's file line number."},"domain":{"type":"string","example":"example.com","format":"domain","description":"The zone record's domain."},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types):\n* `A` - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.\n* `A6` - A6 records store IPv6 addresses.\n* `AAAA` - AAAA records store IPv6 addresses.\n* `AFSDB` - AFSDB records store the location of an AFS cell's database servers.\n* `ALIAS` - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.\n* `CAA` - CAA records control which certificate authorities can issue SSL certificates for a domain.\n* `CNAME` - CNAME records create an alias to another hostname.\n* `DNAME` - DNAME records create an alias for a hostname and its subnames.\n* `DS` - DS records specify a record's delegation signer.\n* `HINFO` - HINFO records specify a host's CPU and OS types.\n* `LOC` - LOC records store a hostname's geographical location.\n* `MX` - MX records point a domain name to its MTAs.\n* `NS` - NS records store a domain's authoritative nameservers.\n* `PTR` - PTR records point to a CNAME.\n* `RP` - RP records store a domain's Responsible Person's information.\n* `SOA` - SOA records designate the beginning of a zone of authority.\n* `SRV` - SRV records store the service location records for newer protocols (for example, Autodiscover).\n* `TXT` - TXT records store descriptive text or useful records (for example, SPF or DKIM records).\n\nIf you do not use this parameter, the system retains the current setting.\n\n**Warning:**\n\nAdditional properties may be required based on the `type`.\n\nWhen you call this function, you **must** include the additional parameters for the desired\nzone record type if you use this parameter. Select a zone record from the menu to view the required additional\nparameters:","enum":["A","AAAA","AFSDB","ALIAS","CAA","CNAME","DNAME","DS","HINFO","LOC","MX","NS","PTR","RP","SOA","SRV","TXT"],"example":"A"}}},"DnsEditZoneParameterTypeHINFO":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"type":"object","properties":{"cpu":{"type":"string","description":"The host's CPU type.\n\n**Note:**\n\nFor more information about HINFO records, read [RFC 1700 at IANA](http://tools.ietf.org/html/rfc1700.txt).","example":"INTEL-386"},"os":{"description":"The host's operating system.","example":"UNIX","type":"string"}}}]},"DnsEditZoneParameterTypeMX":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"preference":{"example":"10","description":"The record's priority order.\n\n**Note:**\n\n* Lower values have a higher priority order.\n* For more information about MX records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","type":"integer"},"exchange":{"example":"mail.example.com","format":"domain","description":"The server's location's canonical name (CNAME).","type":"string"}},"type":"object"}]},"DnsEditZoneParameterTypeSRV":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"type":"object","properties":{"priority":{"description":"The target host's priority preference.\n\n**Note:**\n\n* Lower numbers have a higher priority order.\n* For more information about SRV records, read [RFC 2782 at IANA](http://tools.ietf.org/html/rfc2782).","example":"0","type":"integer"},"port":{"type":"integer","example":"389","description":"The target host's port."},"target":{"description":"The service's target host.","format":"domain","example":"service.example.com","type":"string"},"weight":{"example":"2","description":"A relative weight. The system uses this value to rank entries with the same `priority` value.","type":"integer"}}}]},"DnsEditZoneParameterTypeTXT":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"type":"object","properties":{"txtdata":{"description":"The TXT record's data.\n\n**Note:**\n\n* This value **must** include beginning and ending quotes (`\"\"`).\n* Do **not** URI-encode the quotes.\n* For more information about TXT records, read [RFC 1464 at IANA](http://tools.ietf.org/html/rfc1464).","example":"\"v=spf1 a -all\"","type":"string"}}}]},"DnsEditZoneParameterTypeCAA":{"allOf":[{"$ref":"#/components/schemas/DnsEditZoneParameterBase"},{"properties":{"flag":{"example":"0","enum":["0","1"],"description":"Whether the Certificate Authority (CA) will issue an SSL certificate if the CAA resource record contains unknown property tags.\n\n* `0` - The CA will issue an SSL certificate.\n* `1` - The CA will **not** issue an SSL certificate.\n\nFor more information about CAA record flags and property tags, read the [RFC 6844 documentation](https://tools.ietf.org/html/rfc6844#section-3).","type":"integer"},"tag":{"enum":["issue","issuewild","iodef"],"example":"issue","description":"The CAA record's property type.\n\n* `issue` - Authorize a CA to issue a certificate for the domain.\n* `issuewild` - Authorize a CA to issue a wildcard certificate for the domain.\n* `iodef` - Specify a URL to which a CA may report policy violations.","type":"string"},"value":{"type":"string","description":"The CA's domain or URL. This is a valid [SSL provider](https://sslmate.com/labs/caa/),\n`mailto` URL, or a standard URL.\n\n**Note:**\n\nIf you use `iodef` as the `tag` parameter's value, enter a URL that a CA can use to report issues as this parameter's value.","example":"exampleca.com"}},"required":["flag","tag","value"],"type":"object"}]}},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Zones"]}],"paths":{"/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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"Bind reloading on hostname using rndc zone: [example.com]\n","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"editzonerecord"}}}}}}}}},"x-cpanel-available-version":"11","tags":["DNS","DNS Zones"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DnsEditZoneParameterType"}}},"description":"The updated DNS Zone Record.","required":"true"},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --input=json --output=jsonpretty \\\n  editzonerecord\n"},{"lang":"HTTP","label":"HTTP Request (Wire Format)","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","summary":"Update DNS zone record"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Zones","description":"DNS / DNS Zones"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}]},"set_cpanel_updates":{"x-tagGroups":[{"name":"Server Administration","tags":["Updates"]}],"paths":{"/set_cpanel_updates":{"get":{"parameters":[{"required":"true","in":"query","name":"updates","schema":{"type":"string","enum":["daily","manual","never"],"example":"daily"},"description":"The frequency with which to run cPanel & WHM updates on a server.\n- `daily` — Run updates daily.\n- `manual` — Run updates manually.\n- `never` — Never run updates."}],"operationId":"set_cpanel_updates","description":"This function sets the frequency of cPanel & WHM updates.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"set_cpanel_updates","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Cpanel update frequency set to daily"}}},"data":{"properties":{"updates":{"example":"daily","enum":["daily","manual","never"],"description":"The new frequency of server updates.\n- `daily` — Run updates daily.\n- `manual` — Run updates manually.\n- `never` — Never run updates.","type":"string"}},"type":"object"}}}}}}},"x-cpanel-available-version":"11.38","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  set_cpanel_updates \\\n  updates='daily'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_cpanel_updates?api.version=1&updates=daily","lang":"HTTP","label":"URL"}],"tags":["Updates"],"summary":"Update cPanel & WHM update frequency","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"pause_transfer_session":{"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"name":"cPanel Account Transfer","description":"Transfers / cPanel Account Transfer"}],"paths":{"/pause_transfer_session":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"pause_transfer_session","description":"The method name called.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[{"schema":{"type":"string","example":"exampleservercopya20140206192428NtyW"},"description":"The transfer session's ID.","required":"true","name":"transfer_session_id","in":"query"}],"description":"This function pauses an active transfer session.\n\n**Note:**\n\nFor more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","operationId":"pause_transfer_session","x-cpanel-api-version":"WHM API 1","summary":"Suspend active transfer session","tags":["Transfers","cPanel Account Transfer"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  pause_transfer_session \\\n  transfer_session_id='exampleservercopya20140206192428NtyW'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/pause_transfer_session?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW"}]}}},"x-tagGroups":[{"name":"Transfers","tags":["cPanel Account Transfer"]}]},"list_account_enhancements":{"paths":{"/list_account_enhancements":{"get":{"x-cpanel-available-version":"98","x-cpanel-api-version":"WHM API 1","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"list_account_enhancements","description":"The name of the method called."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"output":{"type":"object","properties":{"warnings":{"items":{"example":"(XID svx4zp) The enhancement file “/var/cpanel/account_enhancements/enhancement 5000.json” contains an invalid enhancement “id”: “bad-id”.","type":"string"},"description":"A list of warnings related to account enhancements.","type":"array"}},"description":"Additional output related to the method called."},"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"}}},"data":{"properties":{"enhancements":{"properties":{"id":{"type":"string","description":"The id the account enhancement is for.","example":"sample-enhancement-id"},"name":{"maxLength":"80","type":"string","description":"The name of the account enhancement.","example":"Sample Enhancement"}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Account Enhancements","operationId":"list_account_enhancements","description":"This function retrieves all existing account enhancements on the system.","tags":["Account Enhancements"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  list_account_enhancements\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_account_enhancements?api.version=1","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Enhancements"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Account Enhancements","description":"Accounts / Account Enhancements"}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.97.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"modsec_make_config_inactive":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"tags":["Server Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_make_config_inactive":{"get":{"parameters":[{"required":"true","in":"query","name":"config","schema":{"type":"string","example":"modsec_vendor_configs/example.conf"},"description":"The ModSecurity configuration file's path and filename, relative to the `/etc/apache2/conf.d/` directory."}],"operationId":"modsec_make_config_inactive","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"modsec_make_config_inactive"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{}}}}}}}},"x-cpanel-available-version":"11.46","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_make_config_inactive \\\n  config='modsec_vendor_configs/example.conf'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_make_config_inactive?api.version=1&config=modsec_vendor_configs%2fexample.conf","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove ModSecurity configuration file include"}}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Server Settings","name":"Server Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"setresellerpackagelimit":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"description":"Resellers / Account Limits","name":"Account Limits"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Resellers","tags":["Account Limits"]}],"paths":{"/setresellerpackagelimit":{"get":{"parameters":[{"required":"true","in":"query","name":"user","schema":{"type":"string","example":"username","format":"username"},"description":"The reseller's username."},{"description":"Whether to grant the reseller unlimited package use.\n* `1` — Grant the reseller unlimited package use.\n* `0` — Use package limits.","schema":{"default":"0","example":"0","enum":["0","1"],"type":"integer"},"in":"query","name":"no_limit","required":"false"},{"schema":{"type":"string","example":"package1"},"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.","required":"false","name":"package","in":"query"},{"required":"false","name":"allowed","in":"query","schema":{"enum":["0","1"],"example":"1","type":"integer"},"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."},{"schema":{"example":"5","type":"integer","minimum":"1"},"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.","required":"false","name":"number","in":"query"}],"operationId":"setresellerpackagelimit","description":"This function limits the packages that a reseller assigns to cPanel accounts.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"setresellerpackagelimit"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  setresellerpackagelimit \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellerpackagelimit?api.version=1&user=username","label":"URL","lang":"HTTP"}],"tags":["Resellers","Account Limits"],"summary":"Update reseller's hosting plan limits","x-cpanel-api-version":"WHM API 1"}}}},"modsec_get_settings":{"paths":{"/modsec_get_settings":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_get_settings\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_settings?api.version=1"}],"tags":["ModSecurity","Server Settings"],"summary":"Return ModSecurity configuration","x-cpanel-api-version":"WHM API 1","parameters":[],"operationId":"modsec_get_settings","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"modsec_get_settings","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"settings":{"type":"array","description":"An array of objects containing ModSecurity global configuration settings.","items":{"type":"object","properties":{"default":{"description":"The setting's default value.","oneOf":[{"type":"string"},{"minimum":"0","type":"integer"}]},"engine":{"type":"integer","enum":["1"],"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."},"directive":{"description":"The setting's Apache® configuration directive.","type":"string"},"radio_options":{"type":"array","items":{"type":"object","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":{"type":"string","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."}}},"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."},"name":{"type":"string","description":"The setting's name."},"url":{"type":"string","format":"url","description":"The URL of the setting's entry in the ModSecurity reference manual."},"validation":{"type":"array","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.","type":"object","properties":{"name":{"enum":["startsWith","endsWith"],"description":"One of the following validators:\n\n* `startsWith` - Check if the updated `state` starts with the pattern passed in `arg`.","type":"string"},"arg":{"description":"The regular expression pattern that is used with the validator identified in the `name` property.","type":"string"}}},{"type":"string","enum":["path","honeypotAccessKey","positiveInteger"],"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."}]}},"type":{"type":"string","enum":["text","radio","number"],"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."},"missing":{"enum":["1"],"description":"Whether the setting is missing.\n\n* `1` — The value is missing.","type":"integer"},"description":{"description":"The setting's description. The user's\n[locale](https://go.cpanel.net/locale) may translate this value.","type":"string"},"setting_id":{"description":"The setting ID.","minimum":"0","type":"integer"},"state":{"description":"The setting's current state, if available.","type":"string"}}},"example":[{"url":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secauditengine","name":"Audit Log Level","radio_options":[{"option":"On","name":"Log all transactions."},{"option":"Off","name":"Do not log any transactions."},{"option":"RelevantOnly","name":"Only log noteworthy transactions."}],"engine":"1","directive":"SecAuditEngine","default":"Off","description":"This setting controls the behavior of the audit engine.","state":"","setting_id":"0","type":"radio","missing":"1"},{"setting_id":"6","state":"","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.","name":"Guardian Log","url":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secguardianlog","validation":[{"name":"startsWith","arg":"[|]"},"path"],"missing":"1","directive":"SecGuardianLog","type":"text"}]}},"type":"object"}}}}}}},"x-cpanel-available-version":"11.46"}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"latest_available_mysql_version":{"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"Manage MySQL Server","description":"Databases / Manage MySQL Server"}],"paths":{"/latest_available_mysql_version":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"server":{"type":"string","enum":["mysql","mariadb"],"example":"mariadb","description":"The server's database engine.\n* `mysql`\n* `mariadb`"},"version":{"type":"string","description":"The version number in `major.minor` format.","example":"10.0"}},"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"example":"latest_available_mysql_version","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"cPanel 11.48","parameters":[],"operationId":"latest_available_mysql_version","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.","summary":"Return latest MySQL version","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  latest_available_mysql_version\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/latest_available_mysql_version?api.version=1"}],"tags":["Databases","Manage MySQL Server"]}}},"x-tagGroups":[{"name":"Databases","tags":["Manage MySQL Server"]}]},"list_enhancement_limits":{"x-tagGroups":[{"name":"Resellers","tags":["Account Enhancement Limit"]}],"paths":{"/list_enhancement_limits":{"get":{"parameters":[{"name":"account","in":"query","required":"true","description":"The reseller's username.","schema":{"type":"string","format":"username","example":"username"}}],"operationId":"list_enhancement_limits","description":"This function returns a reseller's account enhancement limits.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"list_enhancement_limits"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","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."}}},"data":{"properties":{"limits":{"additionalProperties":{"description":"The reseller's limit for the account enhancement.","type":"object","x-additionalPropertiesName":"enhancement_id","properties":{"usage":{"example":"15","description":"The total of cPanel accounts that have the specified Account Enhancement.","type":"integer"},"limited":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether the assignment limit is unlimited."},"limit":{"type":"integer","description":"The assignment limit amount.","example":"15"}}}}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.98","tags":["Resellers","Account Enhancement Limit","Account Enhancement","Account Limit"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_enhancement_limits \\\n  account='username'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_enhancement_limits?api.version=1&account=username","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return account enhancement limits"}}},"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"description":"Resellers / Account Enhancement Limit","name":"Account Enhancement Limit"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.97.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"validate_login_token":{"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/validate_login_token":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"payload":{"type":"array","items":{"properties":{"access_token":{"type":"string","description":"The access token that the cPanel Store or cPanel Market provider returns after you log in.","example":"b7a6f029-99fc-11e6-a0bd-87581cb027ac"},"refresh_token":{"type":"string","example":"b7a7107f-99fc-11e6-a0bd-b46329164206","description":"The refresh token that the cPanel Store or cPanel Market provider returns after you log in ."}},"type":"object"},"description":"An array of objects that contain token information."}}},"metadata":{"properties":{"command":{"example":"validate_login_token","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the 'reason' field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"62","parameters":[{"schema":{"example":"cPStore","type":"string"},"description":"The cPanel Store or cPanel Market provider's name.","required":"true","in":"query","name":"provider"},{"in":"query","name":"url_after_login","required":"true","description":"The location to which the cPanel Store or cPanel Market provider redirects the user's browser after they log in.","schema":{"format":"url","example":"http://hostname.example.com/redirectionlocation.cgi?state","type":"string"}},{"schema":{"type":"string","example":"1a676e6f-99fc-11e6-9ab6-e60a769b73bc"},"description":"The login token to validate.","required":"true","in":"query","name":"login_token"}],"operationId":"validate_login_token","description":"This function validates a login token with the cPanel Store or a cPanel Market provider, and then returns access tokens.","x-cpanel-api-version":"WHM API 1","summary":"Validate login token and return access token","tags":["Authentication","Market Integration"],"x-codeSamples":[{"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":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","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-tagGroups":[{"name":"Commerce Integration","tags":["Market Integration"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Commerce Integration / Market Integration","name":"Market Integration"}]},"restore_queue_clear_all_pending_tasks":{"paths":{"/restore_queue_clear_all_pending_tasks":{"get":{"operationId":"restore_queue_clear_all_pending_tasks","description":"This function removes any pending tasks from the restoration queue.","parameters":[],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"restore_queue_clear_all_pending_tasks","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  restore_queue_clear_all_pending_tasks\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_pending_tasks?api.version=1"}],"tags":["Account Restoration","Restore Queue Management"],"summary":"Remove all pending restoration tasks","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"name":"Restore Queue Management","description":"Account Restoration / Restore Queue Management"}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"start_background_pkgacct":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"description":"The Backups module for WHM API 1.","name":"Backups"},{"description":"Backups / Backup or Restore","name":"Backup or Restore"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Backups","tags":["Backup or Restore"]}],"paths":{"/start_background_pkgacct":{"get":{"tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  start_background_pkgacct \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/start_background_pkgacct?api.version=1&user=username","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Back up an account using the pkgacct script","parameters":[{"required":"true","in":"query","name":"user","schema":{"format":"username","example":"username","type":"string"},"description":"The cPanel account to back up."},{"in":"query","name":"compressionsetting","required":"false","description":"Whether to compress the data in .gzip format.\n* `compress` - Compress the data.\n* `null` - Do **not** compress the data.","schema":{"type":"string","default":null,"example":"compress","enum":["compress"],"nullable":"true"}},{"required":"false","name":"incremental","in":"query","schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"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."},{"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.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"name":"low_priority","in":"query","required":"false"},{"required":"false","name":"mysqlver","in":"query","schema":{"type":"string","example":"5.5"},"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":"serialized_output","required":"false","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.","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"}},{"required":"false","name":"skipacctdb","in":"query","schema":{"default":"0","example":"1","enum":["0","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."},{"name":"skipapitokens","in":"query","required":"false","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.","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.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"name":"skipauthnlinks","in":"query","required":"false"},{"required":"false","in":"query","name":"skipbwdata","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."},{"required":"false","in":"query","name":"skipdnssec","schema":{"example":"1","enum":["0","1"],"default":"0","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."},{"schema":{"example":"1","enum":["0","1"],"default":"0","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.","required":"false","name":"skipdnszones","in":"query"},{"required":"false","name":"skipftpusers","in":"query","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."},{"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.","required":"false","name":"skiphomedir","in":"query"},{"required":"false","name":"skiplinkednodes","in":"query","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"},"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."},{"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.","schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"in":"query","name":"skiplogs","required":"false"},{"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.","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"name":"skipresellerconfig","in":"query","required":"false"},{"required":"false","name":"skipshell","in":"query","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"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":"skipvhosttemplates","required":"false","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.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]}},{"description":"Whether to create the cpmove archive in chunks.\n* `1` — Create the archive in chunks.\n* `0` — Create a single archive file.","schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"in":"query","name":"split","required":"false"},{"required":"false","in":"query","name":"tarroot","schema":{"type":"string","example":"/home/user"},"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."},{"schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"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.","required":"false","name":"use_backups","in":"query"}],"operationId":"start_background_pkgacct","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"session_id":{"description":"The backup's session ID.","example":"example20151109162046c4xzDp55q9u4tPj","type":"string"},"complete_master_log":{"type":"string","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"},"complete_master_error_log":{"example":"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.","type":"string"}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"description":"The method name called.","example":"start_background_pkgacct","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"54"}}}},"list_configclusterservers":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/list_configclusterservers":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"example":"list_configclusterservers","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}},"data":{"example":{"example2.com":{"user":"root","signature":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d1"},"example1.com":{"signature":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","user":"root"}},"description":"Configuration cluster signatures and users for each server.","additionalProperties":{"properties":{"signature":{"type":"string","description":"A truncated version of the server's remote access key."},"user":{"description":"The `root`-level username for the server.","type":"string"}},"type":"object","description":"Each return's name is the server name."},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11.44","parameters":[],"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","x-cpanel-api-version":"WHM API 1","summary":"Return all configuration cluster servers","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_configclusterservers\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_configclusterservers?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"tags":["Configuration Clusters"],"name":"Server Administration"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Configuration Clusters","description":"Server Administration / Configuration Clusters"}]},"nat_set_public_ip":{"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"IP Addresses","description":"The IP Addresses module for WHM API 1."},{"description":"IP Address Management / Network Address Translation","name":"Network Address Translation"}],"paths":{"/nat_set_public_ip":{"get":{"parameters":[{"schema":{"type":"string","example":"192.168.4.10","format":"ipv4"},"description":"The local IPv4 address.","required":"true","in":"query","name":"local_ip"},{"name":"public_ip","in":"query","required":"true","description":"The public IPv4 address.","schema":{"type":"string","example":"10.5.3.33","format":"ipv4"}}],"operationId":"nat_set_public_ip","description":"This function pairs a local IP address with a public IP address on NAT-configured servers.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"example":"nat_set_public_ip","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"11.40","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"},{"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","lang":"HTTP","label":"URL"}],"tags":["IP Addresses","Network Address Translation"],"summary":"Register NAT IP address to public IP address","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"IP Address Management","tags":["Network Address Translation"]}]},"unblock_incoming_email_from_domain":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Spam Management","description":"Mail / Spam Management"}],"paths":{"/unblock_incoming_email_from_domain":{"get":{"parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string"},"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":{"single":{"summary":"A single domain.","value":"example.com"},"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"}}}],"description":"This function unblocks email from specific domains.","operationId":"unblock_incoming_email_from_domain","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated":{"enum":["0","1"],"example":"1","description":"Whether the function unblocked one or more domains.\n* `1` — Success.\n* `0` — Failure.","type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"example":"unblock_incoming_email_from_domain","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"84","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"}],"tags":["Mail","Spam Management"],"summary":"Remove block on emails from specific domains","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Spam Management"],"name":"Mail"}]},"restore_queue_state":{"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"description":"Account Restoration / Restore Queue Reporting","name":"Restore Queue Reporting"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Restore Queue Reporting"],"name":"Account Restoration"}],"paths":{"/restore_queue_state":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"example":{"is_active":"1","active":[{"user":"username","options":{"give_ip":"1","mail_config":"1","mysql":"1","subdomains":"1"},"restore_point":"2019-10-21T00:00:00.000Z"}],"completed":[{"user":"username","restore_point":"2019-10-22T00:00:00.000Z","options":{"mail_config":"0","give_ip":"1","subdomains":"0","mysql":"1"}}],"pending":[{"restore_point":"2019-10-23T00:00:00.000Z","options":{"give_ip":"0","mail_config":"1","mysql":"0","subdomains":"1"},"user":"username"}]},"properties":{"completed":{"description":"An array of objects containing restoration queue items that the system has already processed.","items":{"$ref":"#/components/schemas/restorePoint"},"type":"array"},"pending":{"description":"An array of objects containing restoration queue items that the system will process next.","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.","example":"0","enum":["0","1"],"type":"integer"},"active":{"type":"array","items":{"$ref":"#/components/schemas/restorePoint"},"description":"An array of objects containing restoration queue items that the system is actively processing."}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"restore_queue_state","description":"The method name called."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"description":"This function lists the tasks in the restoration queue.","operationId":"restore_queue_state","parameters":[],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_state?api.version=1","label":"URL","lang":"HTTP"}]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"components":{"schemas":{"restorePoint":{"properties":{"options":{"type":"object","properties":{"mysql":{"description":"Whether the restoration process will restore the account's MySQL®\ndatabases.\n\n* `1` — Will restore.\n* `0` — Will **not** restore.","enum":["1","0"],"example":"1","type":"integer"},"subdomains":{"example":"1","enum":["1","0"],"description":"Whether the restoration process will restore the account's subdomains.\n\n* `1` — Will restore.\n* `0` — Will **not** restore.","type":"integer"},"give_ip":{"example":"1","enum":["1","0"],"description":"Whether the restoration process will assign a dedicated IP address\nto the account.\n\n* `1` — Will assign.\n* `0` — Will **not** assign.","type":"integer"},"mail_config":{"type":"integer","description":"Whether the restoration process will restore the account's email\nconfiguration.\n\n* `1` — Will restore.\n* `0` — Will **not** restore.","example":"1","enum":["1","0"]}}},"restore_point":{"format":"ISO-8601 Date","description":"The date of the backup file.","example":"2019-10-21T00:00:00.000Z","type":"string"},"user":{"description":"The cPanel account's username.","format":"username","example":"username","type":"string"}}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"fetchcrtinfo":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"paths":{"/fetchcrtinfo":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetchcrtinfo?api.version=1&user=username&id=example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"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"},"cabundle":{"type":"string","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-----"},"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"},"key":{"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-----","description":"The private key's text.","type":"string"},"subject.commonName_ip":{"type":"string","example":"192.0.2.0","description":"The certificate's IP address.","format":"ipv4"}},"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"fetchcrtinfo"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.32","parameters":[{"name":"user","in":"query","required":"true","description":"The cPanel account's username.","schema":{"type":"string","example":"username","format":"username"}},{"in":"query","name":"id","required":"true","description":"The certificate's internal system ID.","schema":{"example":"example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd","type":"string"}}],"description":"This function retrieves information about a certificate.","operationId":"fetchcrtinfo"}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}]},"installssl":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"name":"cPanel Account Settings","description":"SSL Certificates / cPanel Account Settings"}],"paths":{"/installssl":{"get":{"description":"This function installs an SSL certificate.","operationId":"installssl","parameters":[{"schema":{"type":"string","example":"example.com","format":"domain"},"description":"The domain's name.","required":"true","in":"query","name":"domain"},{"schema":{"example":"-----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-----","type":"string"},"description":"The certificate's text.\n\n**Note:**\n\nYou **must** URI-encode this value.","required":"true","name":"crt","in":"query"},{"in":"query","name":"key","required":"true","description":"The certificate's key.\n\n**Note:**\n\nYou **must** URI-encode this value.","schema":{"type":"string","example":"-----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-----"}},{"in":"query","name":"cab","required":"false","description":"The certificate's certificate authority (CA) bundle.\n\nIf you do not use this parameter, the system automatically determines the\nappropriate CA bundle file to use.\n\n**Note:**\n\nYou **must** URI-encode this value.","schema":{"example":"-----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-----","type":"string"}},{"description":"The IP address of the certificate's domain.\n\nThis parameter defaults to the domain's local IP address.","schema":{"format":"ipv4","example":"192.168.0.20","type":"string"},"in":"query","name":"ip","required":"false"}],"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"user":{"example":"username","description":"The username for the account on which the function installed the SSL certificate.","format":"username","type":"string"},"statusmsg":{"description":"A message of success or a reason for failure.","example":"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.","type":"string"},"servername":{"type":"string","example":"example.com","description":"The server's hostname.","format":"hostname"},"aliases":{"type":"array","items":{"format":"domain","type":"string"},"description":"A list of domain aliases on the account.","example":["mail.example.com","subdomain.example.com"]},"domain":{"type":"string","description":"The domain on which the function installed the SSL certificate.","format":"domain","example":"example.com"},"action":{"type":"string","description":"The action for the function to execute.","enum":["install"],"example":"install"},"ip":{"type":"string","description":"The domain's IP address.","format":"ipv4","example":"192.168.0.20"},"working_domains":{"type":"array","description":"An list of domains on which the function installed the SSL certificates.","items":{"format":"domain","type":"string"},"example":["example.com","mail.example.com"]},"message":{"type":"string","example":"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.","description":"A message of success or a reason for failure."},"warning_domains":{"items":{"type":"string","format":"domain","example":"subdomain.example.com"},"description":"A list of domains associated with the main domain on which the function did **not** install the SSL certificate.","type":"array"},"status":{"enum":["1","0"],"example":"1","description":"Whether the function was successful.\n\n* `1` — Success.\n* `0` — Failure.","type":"integer"},"extra_certificate_domains":{"type":"array","example":["mail.example.com","subdomain.example.com"],"description":"A list of domains that possess additional SSL certificates.","items":{"type":"string","format":"domain"}},"html":{"type":"string","description":"The function's raw HTML output.","example":"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>"}},"type":"object"},"metadata":{"properties":{"output":{"example":"<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.","description":"The function's raw HTML output.","type":"string"},"reason":{"example":"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.","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"installssl","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"}}}},"type":"object"}}}}},"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  installssl \\\n  domain='example.com' \\\n  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-----' \\\n  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-----'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/installssl?api.version=1&domain=example.com&crt=-----BEGIN%2520CERTIFICATE-----%250AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%250AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%250AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%250AggEBALer6vzwFt%252BO6ooHcXpq%252Bi%252FOVVQEY3oWxrqH6mB%252FPssVSxwcf6bLjoO4so%252Fn%250Adrymhb9mqfkOqYVHwnQ%252Fh2uM%252BIw1NKKDfwOljWcgCS24NykbfQUlW%252FSNDTovdDGl%250AT1Aner090Qse%252B19ta8KS%252F3Akz37bkgqMkPO%252FiEOHlF%252FLbLvjfighkoGco51wc6d7%250AHCQwPWR%252BUenbQWzUwR4%252F4Pqw%252FYrxDAv8O%252FEnNfOGwnCnlnFq4a390VGriqMAngzI%250AlRMVDu4qJGW3dFNStVUm71%252B16ba%252FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%250AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%250AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%250ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%250AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%252FBwM%250AfJEvlPO30%252FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%252FB36joYDrOhtiO6XsRw4Zm%250AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%252F0rQp1YPsVN9tBgiag754HPo%250AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%250A52gKM0u2%252BrK%252FzIYjh%252FhooqN%252BTY%252BJQ667JzLzPNenzAYFsoIQgVj6%252FZoFqJA4nbxC%250Azv%252Fspqc0OQ2W9m5egRPDhngKt%252Bi9804N7FeilBL%252FcpEgUHhgzMBi1T9n%252BYBrc6bO%250AjNjvnEQRbqZY%250A-----END%2520CERTIFICATE-----&key=-----BEGIN%2520RSA%2520PRIVATE%2520KEY-----%250AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2feJ5GRmIATYsJIepKbrDy70sq%2budcO8R8xxak0oMZ%2f9mUdpjSNK%2ffLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2fnf%2fOEZLm3ZbnBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2b%2bq62bFV89jkHWTMcKyyqHENo3hc%2blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2bWU0G%2fNPsq40QVSMoqPxyEz4qXo0hvuIlCXmzFZq%2f6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2bQXSNiA1AwWr8l0r4rtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoCt1WJFxQgD4goE0U6k%2bKt7vjbOt14Pk6v%2fB2yjaju1wSGpO59WLS4%2fXrwI2se6IXrmba7u3VUEgWXLriNHoLy7%2fSMNTs%2bZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCsIwpU%2bazosk0oylWLEX%2fm%2fuHWEs1eaIEWWWtgHB%2bKZrrP7Rr9RYfVQ144DxmOxS3Ca9%2bmST62WqAVPR6POWGEfZqnZl%2fePWZPcQYbFrhwnnefNoYBl%2fbnLZBo8rbNWxAqOEOuKfkrBzglKG%2f39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2f3FvwDa3uJpkpmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2fezWe9yn%2bbMpjSIWfsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2f1Tl875opGAqEIJMqss%2fu11tnva5wzu1cCL6H85A5%2bHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1ptXBmXLC%2fYKKvtHI3M16%2fZopvM8ZqU2HcAHaw214Refw9JJ%2fe3%2fxTNfSerVTyCAQO1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2fZfLrc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2b75psgbAr6ELGgItJ9yPBLVRr%2bcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2bewLHVmmsjCyV6xw8JXXF8e2xif3in0m3D%2fwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6dv1Q4EF1%2bfbK3YCW%2bVpCBsB9NAoGAQo%2buhNLODee56iKkzpjXWCsFTq6ar3hD5F3P63buKdNwhd2GlSPhXFbf%2b7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2f4%2f1WbmF8R%2bT7LX1rPLO5p%2fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2fyyHCZFAawUhV%2fZ9EKiHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3DfrxUj6lG3z%2foKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2fcrbLePuBwIR0L7drXxfv7O5btY7h6QI2d1%2fUIAQPAWbxLoTM%2bndQ%2fuPEdfA%253D%253D-----END%2520RSA%2520PRIVATE%2520KEY-----"}],"tags":["SSL","cPanel Account Settings"],"summary":"Install SSL certificate","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["cPanel Account Settings"],"name":"SSL Certificates"}]},"modsec_is_installed":{"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"paths":{"/modsec_is_installed":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"data":{"type":"object","properties":{"installed":{"description":"Whether ModSecurity is installed on the server.\n* `1` — Installed.\n* `0` — **Not** installed.","enum":["0","1"],"example":"1","type":"integer"}}}}},"metadata":{"properties":{"reason":{"type":"string","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"},"command":{"type":"string","example":"modsec_is_installed","description":"The method name called."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.46","parameters":[],"operationId":"modsec_is_installed","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.","x-cpanel-api-version":"WHM API 1","summary":"Return ModSecurity module status","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  modsec_is_installed\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_is_installed?api.version=1"}]}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."}},"twofactorauth_disable_policy":{"x-tagGroups":[{"tags":["Two-Factor Authentication"],"name":"Authentication"}],"paths":{"/twofactorauth_disable_policy":{"get":{"description":"This function disables the Two-Factor Authentication (2FA) security policy on the server.","operationId":"twofactorauth_disable_policy","parameters":[],"x-cpanel-available-version":"54","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"twofactorauth_disable_policy"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"tags":["Authentication","Two-Factor Authentication"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_disable_policy\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_disable_policy?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Disable 2FA"}}},"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"Two-Factor Authentication","description":"Authentication / Two-Factor Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"reset_autossl_provider":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"paths":{"/reset_autossl_provider":{"get":{"parameters":[{"in":"query","name":"provider","required":"true","description":"The AutoSSL provider's name.","schema":{"type":"string","example":"cPanel"}},{"description":"Additional parameters which you wish to pass to the AutoSSL provider.\n\n**Note:**\n\n These additional parameters begin with the `x_` prefix.\n For example, the Let's Encrypt provider accepts the `x_terms_of_service_accepted` parameter,\n to which you would pass the URL of the terms of service that you accept.","schema":{"example":"(varies)","type":"string"},"name":"x_*","in":"query","required":"false"}],"operationId":"reset_autossl_provider","description":"This function resets the AutoSSL registration with a remote AutoSSL provider.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"reset_autossl_provider","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"58","tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  reset_autossl_provider \\\n  provider='cPanel'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/reset_autossl_provider?api.version=1&provider=cPanel","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Restore AutoSSL registration"}}}},"set_postgresql_password":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"PostgreSQL Databases","description":"Databases / PostgreSQL Databases"}],"paths":{"/set_postgresql_password":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Databases","PostgreSQL Databases"],"summary":"Update PostgreSQL user password","x-cpanel-api-version":"WHM API 1","operationId":"set_postgresql_password","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.","parameters":[{"required":"true","in":"query","name":"user","schema":{"type":"string","example":"username"},"description":"The account's username."},{"in":"query","name":"password","required":"true","description":"The database user's new password.","schema":{"example":"12345luggage","type":"string"}},{"required":"false","in":"query","name":"cpuser","schema":{"type":"string","example":"example"},"description":"The database user's owner."}],"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"set_postgresql_password","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["PostgreSQL Databases"],"name":"Databases"}]},"list_user_child_nodes":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/list_user_child_nodes":{"get":{"parameters":[],"operationId":"list_user_child_nodes","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"list_user_child_nodes"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}},"data":{"properties":{"payload":{"type":"array","description":"A list of cPanel accounts and the linked cPanel & WHM servers on which they exist.","items":{"properties":{"type":{"type":"string","example":"Mail","enum":["Mail"],"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."},"alias":{"description":"The name (alias) of the linked cPanel & WHM server.","example":"MailServer1","type":"string"},"user":{"description":"The cPanel account username.","example":"username1","type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"88","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  list_user_child_nodes\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_user_child_nodes?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel accounts with server name and type"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Server Nodes"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Server Nodes","description":"Server Administration / Server Nodes"}]},"get_licenses":{"paths":{"/get_licenses":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"get_licenses","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details."}}},"current":{"items":{"type":"object","properties":{"valid":{},"product":{},"adddate":{},"company":{},"producttype":{},"expdate":{},"status":{},"package":{},"basepkg":{}}},"type":"array"},"history":{"items":{"properties":{"valid":{},"package":{},"status":{},"expdate":{},"basepkg":{},"producttype":{},"adddate":{},"company":{},"product":{}},"type":"object"},"type":"array"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"90","parameters":[{"in":"query","name":"ip","required":"false","description":"The IPv4 address.","schema":{"type":"string","default":"the server's IP address","example":"192.0.2.0"}}],"x-cpanel-internal-only":"true","operationId":"get_licenses","description":"This function returns all the current and past licenses for an IP address.","summary":"Return licenses for an IP","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_licenses\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_licenses?api.version=1","lang":"HTTP","label":"URL"}],"tags":["System Information"]}}},"x-tagGroups":[{"tags":["System Information"],"name":"Server Administration"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"System Information"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.91.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"verify_user_has_feature":{"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Hosting Plans / Feature Access","name":"Feature Access"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Access"]}],"paths":{"/verify_user_has_feature":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  verify_user_has_feature \\\n  user='username' \\\n  feature='sslinstall'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_user_has_feature?api.version=1&user=username&feature=sslinstall"}],"tags":["Packages","Feature Access"],"summary":"Return cPanel account feature access","x-cpanel-api-version":"WHM API 1","parameters":[{"description":"The cPanel account username.","schema":{"type":"string","example":"username","format":"username"},"name":"user","in":"query","required":"true"},{"schema":{"type":"string","example":"sslinstall"},"description":"The feature's ID.\n\n**Note:**\n\nCall WHM API 1's `get_feature_names` function to view available features.","required":"true","in":"query","name":"feature"}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"has_feature":{"type":"integer","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"},"query_feature":{"type":"string","description":"The queried feature's ID.","example":"sslinstall"}},"type":"object"},"metadata":{"properties":{"command":{"example":"verify_user_has_feature","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"x-cpanel-available-version":"56"}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}}},"delete_cpgreylist_trusted_host":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Mail","tags":["Spam Protection (Greylisting)"]}],"paths":{"/delete_cpgreylist_trusted_host":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"ips_failed":{"additionalProperties":{"description":"A failed IP address and the error message.","type":"string"},"type":"object","example":{"5.5":"Invalid IP address or range: “5.5”"},"description":"An object that contains the IP addresses that the function failed to remove from the _Trusted Hosts_ list."},"ips_removed":{"type":"array","example":["192.168.0.1","2001:db8::1"],"items":{"type":"string"},"description":"An array of IP addresses that the function removed from the _Trusted Hosts_ list."}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"delete_cpgreylist_trusted_host"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}}}}}}}},"x-cpanel-available-version":"11.50","parameters":[{"examples":{"single":{"description":"A single IP address.","value":"192.168.0.1"},"cidr-ipv4":{"value":"192.168.0.1/16","summary":"CIDR Format IPv4"},"multiple":{"description":"Multiple IP addresses.","value":"ip-1=192.168.0.1&ip-2=192.168.0.2&ip-3=192.168.0.3"},"single-ipv6":{"value":"2001:db8::1","summary":"Single IPv6 Address"},"single-ipv4":{"value":"192.0.2.0","summary":"Single IPv4 Address"},"cidr-ipv6":{"value":"2001:db8::/32","summary":"CIDR Format IPv6"}},"description":"The record's IP address, or a range of IP addresses.\n\n**Note:**\n\nTo add multiple IP addresses, increment the parameter name (for example, `ip-1`, `ip-2`, `ip-3`).","schema":{"example":"192.168.0.1","type":"string"},"in":"query","name":"ip","required":"true"}],"operationId":"delete_cpgreylist_trusted_host","description":"This function deletes an IP address from the Greylisting _Trusted Hosts_ list.","summary":"Remove IP address from Greylisting trusted hosts","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_cpgreylist_trusted_host \\\n  ip='192.168.0.1'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_cpgreylist_trusted_host?api.version=1&ip=192.168.0.1"}],"tags":["Greylisting","Spam Protection (Greylisting)"]}}}},"rename_mysql_database":{"paths":{"/rename_mysql_database":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  rename_mysql_database \\\n  oldname='database' \\\n  newname='database2'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_mysql_database?api.version=1&oldname=database&newname=database2"}],"tags":["Databases","MySQL Databases"],"summary":"Update MySQL database name","x-cpanel-api-version":"WHM API 1","operationId":"rename_mysql_database","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.","parameters":[{"name":"oldname","in":"query","required":"true","description":"The database's current name.","schema":{"type":"string","example":"database"}},{"schema":{"example":"database2","type":"string","maxLength":"64"},"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.","required":"true","in":"query","name":"newname"},{"description":"The database's owner.","schema":{"example":"username","format":"username","type":"string"},"in":"query","name":"cpuser","required":"false"}],"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","example":"rename_mysql_database","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"tags":["MySQL Databases"],"name":"Databases"}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"MySQL Databases","description":"Databases / MySQL Databases"}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"fetch_ssl_vhosts":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}],"paths":{"/fetch_ssl_vhosts":{"get":{"operationId":"fetch_ssl_vhosts","description":"This function lists the server's virtual hosts (vhosts) and their installed SSL certificates.","parameters":[],"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"vhosts":{"items":{"type":"object","properties":{"crt":{"type":"object","properties":{"created":{"example":"1538308800","format":"unix_timestamp","description":"The date the certificate was created.","type":"integer"},"public_exponent":{"example":"010001","description":"The certificate's exponent.","type":"string"},"is_self_signed":{"type":"integer","description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":["1","0"],"example":"1"},"subject.commonName":{"description":"An object containing the certificate's Common Name.","type":"object","properties":{"commonName":{"example":"example.com","description":"The certificate's Common Name.","type":"string"}}},"issuer.organizationName":{"example":"Organization","description":"The certificate's Organization Name.","type":"string"},"subject_text":{"example":"commonName\nsubdomain.example.com","description":"The certificate's subject text.","type":"string"},"domains":{"type":"array","example":["example.com","subdomain.example.com"],"description":"A list of the certificate's associated domains.","items":{"format":"domain","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"},"ecdsa_curve_name":{"type":"string","nullable":"true","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.","example":null,"enum":["prime256v1","secp384r1"]},"modulus_length":{"example":"2048","description":"The certificate's key's modulus length.\n\n* `null` — The certificate's key is **not** an RSA key.","nullable":"true","type":"integer"},"id":{"description":"The certificate's ID.","example":"example1_com_e353a_5bc13_1408033388_9a1d40aff655f98fed7206e5af466065","type":"string"},"not_after":{"format":"unix_timestamp","description":"The date the certificate expires.","example":"1601467200","type":"integer"},"encryption_algorithm":{"type":"string","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA."},"not_before":{"format":"unix_timestamp","description":"The date the certificate became active.","example":"1569844800","type":"integer"},"issuer.commonName":{"type":"string","description":"The certificate's issuer.","example":"example.com"},"validation_type":{"type":"string","nullable":"true","example":"dv","enum":["dv","ev","ov"],"description":"The certificate's validation type.\n\n* `dv` — Domain validation.\n* `ev` — Extended validation.\n* `ov` — Organizational validation.\n* `null` — Self-signed certificate."},"ecdsa_public":{"nullable":"true","example":null,"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.","type":"string"},"signature_algorithm":{"type":"string","description":"The certificate's OID hash algorithm.","example":"sha256WithRSAEncryption"},"issuer_text":{"type":"string","example":"commonName\nsubdomain.example.com","description":"The full text of issuer information."}},"description":"Information about the certificate."},"user":{"type":"string","example":"example","description":"The virtual host's username.","format":"username"},"servername":{"description":"The virtual host's primary domain.","format":"domain","example":"example.com","type":"string"},"mail_sni_status":{"enum":["1","0"],"example":"1","description":"Whether SNI for mail is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"},"ip":{"description":"The virtual host's IP address.","format":"ipv4","example":"192.168.0.20","type":"string"},"docroot":{"format":"path","description":"The absolute directory path of the primary domain's document root.","example":"/home/example/public_html","type":"string"},"is_primary_on_ip":{"type":"integer","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":{"type":"string","enum":["addon","main","parked","sub"],"example":"sub","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."},"iptype":{"type":"string","description":"The type of IP address.\n\n* `shared`\n* `dedicated`","example":"dedicated","enum":["shared","dedicated"]},"ipv6":{"type":"string","example":"2001:0db8:0:0:1:0:0:1","description":"The virtual host's IPv6 address.","format":"ipv6"},"domains":{"type":"array","example":["example.com"],"items":{"type":"string","format":"domain"},"description":"A list of the virtual host's domains."},"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.","example":"0","enum":["1","0"],"type":"integer"}}},"description":"An array of objects containing virtual host information.","type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"fetch_ssl_vhosts","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetch_ssl_vhosts\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_ssl_vhosts?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return server vhosts and SSL certificates"}}}},"get_feature_metadata":{"paths":{"/get_feature_metadata":{"get":{"summary":"Return current user's available feature lists info","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_feature_metadata\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_feature_metadata?api.version=1"}],"tags":["Packages","Feature Lists"],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"get_feature_metadata"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"properties":{"features":{"description":"An array of objects containing information about a feature.","items":{"properties":{"id":{"type":"string","description":"The feature's ID.","example":"addondomains"},"name":{"type":"string","example":"Addon Domain Manager","description":"The feature's name."},"is_plugin":{"description":"Whether the feature is a plugin.\n\n* `1` — Plugin.\n* `0` — **Not** a plugin.","example":"0","enum":["1","0"],"type":"integer"},"is_cpaddon":{"example":"0","enum":["1","0"],"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.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}}}}}}},"operationId":"get_feature_metadata","description":"This function lists the details of the authenticated user's available feature lists.","parameters":[]}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Lists"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"list_mysql_databases_and_users":{"x-tagGroups":[{"tags":["MySQL Databases"],"name":"Databases"}],"paths":{"/list_mysql_databases_and_users":{"get":{"parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","format":"username","example":"username"},"description":"The username for a specified account."}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"type":"string","description":"The method name called.","example":"list_mysql_databases_and_users"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"type":"object","properties":{"mysql_config":{"type":"object","properties":{"mysql-version":{"example":"5.5","description":"The MySQL version installed on the server.","type":"string"},"prefix_length":{"enum":["8","16"],"example":"8","description":"The maximum number of characters allowed for the prefix on this server.","type":"integer"},"use_db_prefix":{"example":"1","enum":["0","1"],"description":"Whether database prefixing is enabled on the server.\n* `1` — Enabled.\n* `0` — Disabled.","type":"integer"}},"description":"An object that contains the user's MySQL database configuration settings."},"mysql_databases":{"description":"An object that contains database names and users.","example":{"user2_database2":["user2_user2"],"user1_database1":["user1_user1"]},"type":"object","additionalProperties":{"type":"array","items":{"description":"A database username with permissions on the database.","type":"string"},"description":"The database's name is the key's name."}}}}},"type":"object"}}}}},"x-cpanel-available-version":"56","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  list_mysql_databases_and_users \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_mysql_databases_and_users?api.version=1&user=username","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return MySQL databases and users for account"}}},"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"MySQL Databases","description":"Databases / MySQL Databases"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"get_autossl_providers":{"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/get_autossl_providers":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"get_autossl_providers","description":"The method name called."},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","example":"1","enum":["0","1"]},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"payload":{"type":"array","items":{"properties":{"display_name":{"description":"The AutoSSL provider module's display name.","example":"Sectigo","type":"string"},"x_terms_of_service":{"example":"https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf","format":"url","description":"The URL of the provider's current terms of service.\n\n**Note:**\n\nIf the terms of service available at the `x_terms_of_service` location is newer than the `x_terms_of_service_accepted` location, the system administrator will need to accept the new terms of service.","type":"string"},"module_name":{"example":"cPanel","description":"The AutoSSL provider module's name.","type":"string"},"x_account_id":{"type":"string","description":"The user's account profile URL at the provider.","example":"https://acme-v01.api.letsencrypt.org/acme/reg/12345678"},"x_terms_of_service_accepted":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether the AutoSSL provider is Enabled.\n\n* `1` - The AutoSSL provider is enabled.\n* `0` - The AutoSSL provider is **not** enabled."},"enabled":{"type":"integer","description":"Whether the AutoSSL provider is enabled.\n* `1` - The provider is enabled.\n* `0` - The provider is disabled.","example":"1","enum":["0","1"]},"specs":{"description":"The provider's specifications.","type":"object","properties":{"SUPPORTS_ANCESTOR_DCV":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the successful Domain Control\nValidation (DCV) of a parent domain implies the\nsuccess of a subdomain.\n\n* `1` - The provider supports DCV.\n* `0` - The provider does **not** support DCV.\""},"HTTP_DCV_MAX_REDIRECTS":{"type":"integer","description":"The maximum number of redirections a domain can use and still pass an HTTP-based DCV.","example":"10"},"AVERAGE_DELIVERY_TIME":{"type":"integer","example":"120","description":"The amount of time in seconds that the provider requires to issue a certificate."},"MAX_DOMAINS_PER_CERTIFICATE":{"minimum":"1","type":"integer","description":"The number of unique domains each certificate can contain.","example":"100"},"VALIDITY_PERIOD":{"type":"integer","description":"The amount of time before the certificate expired, in seconds.\n\n**Note:**\n\n\n A valid integer.","example":"7776000"},"SUPPORTS_WILDCARD":{"type":"integer","description":"Whether the provider supports wildcard\ndomains on an SSL certificate.\n\n* `1` - The provider supports wildcard domains.\n* `0` - The provider does **not** support wildcard domains.","enum":["0","1"],"example":"1"},"DCV_METHODS":{"type":"array","description":"The methods that the provider uses\nto validate the domain.\n\n* `dns` - DNS Validation Method.\n* `http` - HTTP Validation Method.","items":{"example":"http","enum":["dns","http"],"type":"string"}},"RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK":{"type":"integer","example":"50","description":"The maximum number of certificates that the provider will allow per domain in a week."},"DELIVERY_METHOD":{"description":"The method that the provider uses\nto issue the certificate.\n\n* `queue` - The provider delivers certificates through a download queue.\n* `api` - The provider delivers certificates through API calls.","example":"queue","enum":["queue","api"],"type":"string"}}}},"additionalProperties":{"description":"Additional returns specific to the AutoSSL provider module. The name of the property will always start with `x_`."},"type":"object"},"description":"This array of objects contains information about available AutoSSL providers.","example":[{"display_name":"Sectigo","specs":{"HTTP_DCV_MAX_REDIRECTS":"0","SUPPORTS_ANCESTOR_DCV":"1","DELIVERY_METHOD":"queue","RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK":"0","DCV_METHODS":["http","dns"],"SUPPORTS_WILDCARD":"0","MAX_DOMAINS_PER_CERTIFICATE":"1000","VALIDITY_PERIOD":"7776000","AVERAGE_DELIVERY_TIME":"120"},"enabled":"1","module_name":"cPanel"},{"x_terms_of_service_accepted":"1","enabled":"0","specs":{"DELIVERY_METHOD":"api","RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK":"50","DCV_METHODS":["http","dns"],"SUPPORTS_WILDCARD":"1","VALIDITY_PERIOD":"7776000","MAX_DOMAINS_PER_CERTIFICATE":"100","AVERAGE_DELIVERY_TIME":"5","HTTP_DCV_MAX_REDIRECTS":"10","SUPPORTS_ANCESTOR_DCV":"0"},"display_name":"Let’s Encrypt™","x_terms_of_service":"https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf","module_name":"LetsEncrypt","x_account_id":"https://acme-v01.api.letsencrypt.org/acme/reg/12345678"}]}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"58","parameters":[],"operationId":"get_autossl_providers","description":"This function lists available AutoSSL providers on the server.","x-cpanel-api-version":"WHM API 1","summary":"Return available AutoSSL providers","tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_autossl_providers\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_providers?api.version=1","label":"URL","lang":"HTTP"}]}}},"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}]},"restore_queue_clear_pending_task":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"description":"Account Restoration / Restore Queue Management","name":"Restore Queue Management"}],"paths":{"/restore_queue_clear_pending_task":{"get":{"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"}],"tags":["Account Restoration","Restore Queue Management"],"summary":"Remove pending restoration task","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"username"},"description":"The cPanel account's username."}],"operationId":"restore_queue_clear_pending_task","description":"This function removes a single pending task from the restoration queue.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_pending_task","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38"}}},"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Management"]}]},"ticket_remove_closed":{"tags":[{"name":"Support Tickets","description":"The Support Tickets module for WHM API 1."},{"name":"Support Access","description":"cPanel Support Tickets / Support Access"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Support Access"],"name":"cPanel Support Tickets"}],"paths":{"/ticket_remove_closed":{"get":{"description":"This function removes cPanel Support's SSH keys and removes closed\nsupport tickets. You can view closed support tickets in WHM's\n[*Grant cPanel Support Access*](https://docs.cpanel.net/whm/support/grant-cpanel-support-access/)\ninterface (*WHM >> Home >> Support >> Grant cPanel Support Access*).\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call\nit as a request body.","operationId":"ticket_remove_closed","parameters":[],"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","description":"The method name called.","example":"ticket_remove_closed"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"properties":{"csf_wl_status":{"enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"example":"ACTIVE","description":"The status of the\n[ConfigServer Security & Firewall (CSF)](https://www.configserver.com/)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate CSF whitelist entries or they\nalready existed.\n* `INACTIVE` — The CSF whitelist entries were successfully removed or they\nwere already deleted.\n* `ERR_SETUP` — The system failed to add the CSF whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the CSF whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.\n\n**Note:**\n\nIf CSF does not exist on the server, the function will **not**\ndisplay this return.","type":"string"},"hulk_wl_status":{"type":"string","description":"The status of the\n[cPHulk](https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/)\nwhitelist entries.\n\n* `ACTIVE` — The system added the appropriate cPHulk whitelist entries or they\nalready existed.\n* `INACTIVE` — The cPHulk whitelist entries were successfully removed or they\nwere already deleted.\n* `ERR_SETUP` — The system failed to add the cPHulk whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the cPHulk whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"]},"chain_status":{"description":"The status of the `iptables` whitelist entries.\n\n* `ACTIVE` — The system added the appropriate `iptables` whitelist entries,\nor they already existed.\n* `INACTIVE` — The system successfully removed the `iptables` whitelist\nentries, or they did not exist.\n* `ERR_SETUP` — The system failed to add the `iptables` whitelist entries.\n* `ERR_UNSETUP` — The system failed to remove the `iptables` whitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"type":"string"},"non_fatals":{"example":[],"description":"Any non-fatal errors.\n\n* `ticket_system_log_entry` — The function could not record the grant operation\nin the ticket.\n* `audit_log` — The function could not record the grant operation in the local\naudit log.\n\n**Note:**\n\nThe system stores the local audit log in the\n`/var/cpanel/logs/supportauth/audit.log` file.","items":{"enum":["ticket_system_log_entry","audit_log"],"type":"string"},"type":"array"},"host_access_wl_status":{"type":"string","example":"INACTIVE","enum":["ACTIVE","INACTIVE","ERR_SETUP","ERR_UNSETUP","ERR_UNKNOWN"],"description":"The status of the `/etc/hosts.allow` file's whitelist entries.\n\n* `ACTIVE` — The system added the appropriate `/etc/hosts.allow` file whitelist\nentries or they already existed.\n* `INACTIVE` — The `/etc/hosts.allow` file whitelist entries were successfully\nremoved or they were already deleted.\n* `ERR_SETUP` — The system failed to add the `/etc/hosts.allow` file whitelist\nentries.\n* `ERR_UNSETUP` — The system failed to remove the `/etc/hosts.allow` file\nwhitelist entries.\n* `ERR_UNKNOWN` — An unknown error occurred."},"revoked_keys":{"minimum":"1","type":"integer","example":"9","description":"The total number of SSH keys that the system removed."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_remove_closed?api.version=1"}],"tags":["Support Tickets","Support Access"],"summary":"Delete Support SSH key and closed tickets","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"start_autossl_check_for_all_users":{"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"paths":{"/start_autossl_check_for_all_users":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"command":{"type":"string","description":"The method name called.","example":"start_autossl_check_for_all_users"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"pid":{"example":"29193","description":"The process ID of the script.","type":"integer","minimum":"1"}},"type":"object"}}}}}}},"x-cpanel-available-version":"58","parameters":[],"operationId":"start_autossl_check_for_all_users","description":"This function performs an AutoSSL certificate check in the background for all cPanel users that have the feature enabled.","summary":"Start AutoSSL check for all cPanel accounts","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  start_autossl_check_for_all_users\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/start_autossl_check_for_all_users?api.version=1","lang":"HTTP","label":"URL"}],"tags":["SSL","Auto-Generated Certificates"]}}},"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"openapi":"3.0.2","info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"list_users":{"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Account Management","description":"Accounts / Account Management"}],"paths":{"/list_users":{"get":{"parameters":[],"description":"This function lists the cPanel user accounts and the `root` user on the server.","operationId":"list_users","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`.\n\n**Note:**\n\nThis field may display a success message when a function succeeds.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"list_users","description":"The method name called.","type":"string"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}},"data":{"properties":{"users":{"type":"array","items":{"type":"string"},"description":"A list of cPanel user accounts. The list may consist of the following types of accounts:\n\n* A valid cPanel username.\n* `root`","example":["example","root"]}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_users\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_users?api.version=1"}],"tags":["Account Management"],"summary":"Return root and cPanel accounts","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Account Management"],"name":"Accounts"}],"openapi":"3.0.2","info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"start_profile_activation":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Profiles","name":"Server Profiles"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"tags":["Server Profiles"],"name":"Server Administration"}],"paths":{"/start_profile_activation":{"get":{"operationId":"start_profile_activation","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.","parameters":[{"schema":{"example":"MAILNODE","enum":["STANDARD","DATABASENODE","MAILNODE","DNSNODE"],"type":"string"},"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.","required":"true","name":"code","in":"query"},{"required":"false","name":"optional","in":"query","content":{"application/json":{"schema":{"example":{"SpamFilter":"1","DNS":"0"},"type":"object","additionalProperties":{"type":"integer","enum":["1","0"],"example":"0","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."}}}},"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."}],"x-cpanel-available-version":"76","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"log_id":{"type":"string","description":"The profile activation log ID. The system creates the log files in the `/var/cpanel/logs/activate_profile/` directory.","example":"17053.10418168.1533478604"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"start_profile_activation","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  start_profile_activation \\\n  code='MAILNODE'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/start_profile_activation?api.version=1&code=MAILNODE","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update server node profile"}}}},"unsuspend_outgoing_email":{"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"paths":{"/unsuspend_outgoing_email":{"get":{"summary":"Unsuspend account outgoing email","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  unsuspend_outgoing_email \\\n  user='example'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/unsuspend_outgoing_email?api.version=1&user=example","label":"URL","lang":"HTTP"}],"tags":["Mail","cPanel Account Mail Management"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"unsuspend_outgoing_email","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"56","parameters":[{"schema":{"example":"example","type":"string"},"description":"The cPanel account.","required":"true","in":"query","name":"user"}],"description":"This function unsuspends outgoing email for a cPanel account's users.","operationId":"unsuspend_outgoing_email"}}},"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"openapi":"3.0.2","info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"convert_addon_initiate_conversion":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"88","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"paths":{"/convert_addon_initiate_conversion":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"metadata":{"properties":{"reason":{"type":"string","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"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","example":"1","description":"The API version of the function."},"command":{"type":"string","example":"convert_addon_initiate_conversion","description":"The method name called."}}}}}}}}},"x-cpanel-available-version":"56","parameters":[{"required":"true","in":"query","name":"username","schema":{"example":"username","format":"username","type":"string"},"description":"The username for a specified account."},{"required":"true","name":"domain","in":"query","schema":{"type":"string","format":"domain","example":"example.com"},"description":"The addon domain to convert into an account's main domain."},{"in":"query","name":"pkgname","required":"false","description":"The hosting package that you want to assign to the new account.","schema":{"default":"default","example":"mycustompkg","type":"string"}},{"name":"copymysqldb-*","in":"query","required":"false","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":{"single":{"value":"newdatabase","summary":"Copy a single database."},"multiple":{"value":"copymysqldb-olddatabase1=newdatabase1 copymysqldb-olddatabase2=newdatabase2","summary":"Copy multiple databases."}},"schema":{"type":"string"}},{"schema":{"type":"string"},"examples":{"multiple":{"value":"movemysqldb-1=exampledb1 movemysqldb-2=exampledb2 movemysqluser-3=exampledb3","summary":"Move multiple databases."},"single":{"value":"exampledb","summary":"Move a single database."}},"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`.","required":"false","in":"query","name":"movemysqldb"},{"examples":{"single":{"value":"dbuser1","summary":"Move a single database user."},"multiple":{"value":"movemysqluser-1=dbuser1 movemysqluser-2=dbuser2 movemysqluser-3=dbuser3","summary":"Move multiple database users."}},"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`.","schema":{"type":"string"},"in":"query","name":"movemysqluser","required":"false"}],"operationId":"convert_addon_initiate_conversion","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.","summary":"Start additional domain conversion","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  convert_addon_initiate_conversion \\\n  username='username' \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_initiate_conversion?api.version=1&username=username&domain=example.com","label":"URL","lang":"HTTP"}],"tags":["Domain Information"]}}},"tags":[{"name":"Domain Information","description":"Accounts / Domain Information"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}]},"create_integration_link":{"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Integration module for WHM API 1.","name":"Integration"},{"description":"Integrations / Links","name":"Links"}],"paths":{"/create_integration_link":{"get":{"parameters":[{"schema":{"type":"string","format":"username","example":"username"},"description":"The cPanel account name.","required":"true","name":"user","in":"query"},{"required":"true","in":"query","name":"app","schema":{"type":"string","example":"WHMCS_billing"},"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."},{"description":"The token that the system will present to the URL in the `autologin_token_url` endpoint.","schema":{"type":"string","example":"subway"},"name":"token","in":"query","required":"true"},{"schema":{"type":"string","example":"billing"},"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","required":"true","name":"implements","in":"query"},{"schema":{"type":"string","example":"WHMCS Billing"},"description":"The label to display in the cPanel login interface.","required":"true","in":"query","name":"label"},{"schema":{"example":"1234","type":"string"},"description":"The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.","required":"true","in":"query","name":"subscriber_unique_id"},{"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.)","schema":{"type":"string","format":"json","example":"http://www.example.com/login.cgi"},"name":"autologin_token_url","in":"query","required":"false"},{"schema":{"type":"string","format":"url","example":"http://www.example.com"},"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.","required":"false","in":"query","name":"url"},{"schema":{"format":"base64 image","example":"iVBORw0KGgoAAAANSUhEUgAAAJgAAADYCAYAAA AXmipNAAAACXBIWXMAAALVAAAC1QHAwm8lAAAAGXRFWHRTb2Z0d2FyZQB 3d3cuaW5rc2NhcGUub3Jnm+48GgAAAUNJREFUeJztziFKg2EABuD3+ydz qGBwiGBZ385hstoMu4DNA8w7eIuBRUyWBYvJsC6CYWCwGGSy7bN6AOFn8 DwneJI/6mTYreNBryYl8A9KktTxoJfu0W66y3mSw6Q8pD+/LJNsWv6x5Z p6NbzJ/sF7uj/3Sf3OJqPUep6P0WnbObZfk1qu02zOks0spXylk+eUvOS 4v2g7x/bbSamPSecuqZ+p5TbN6inLvbcyma3azrH9Sr1IJyejQcq6yWL0 WqbTddspAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AANr0C5EmMYv5JZrpAAAAAElFTkSuQmCC","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.","required":"false","name":"base64_png_image","in":"query"},{"description":"The order in which to display the icon in the cPanel interface inside the `group_id` group.","schema":{"example":"999","type":"string"},"in":"query","name":"order","required":"false"},{"schema":{"example":"advanced","enum":["files","databases","domains","email","metrics","security","software","advanced","pref"],"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.","required":"false","in":"query","name":"group_id"},{"description":"Whether the cPanel interface will display the integration link.\n\n * `1` - Do **not** display the link.\n * `0` - Display the link.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"name":"hide","in":"query"}],"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","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"create_integration_link","description":"The method name called.","type":"string"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"54","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"},{"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","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Create integration link"}}},"x-tagGroups":[{"tags":["Links"],"name":"Integrations"}],"openapi":"3.0.2","info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_login_url":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","x-tagGroups":[{"name":"Authentication","tags":["Login URL"]}],"paths":{"/get_login_url":{"get":{"parameters":[{"in":"query","name":"provider","required":"true","description":"The cPanel Store or cPanel Market provider's name.","schema":{"example":"cPStore","type":"string"}},{"required":"true","name":"url_after_login","in":"query","schema":{"example":"http://hostname.example.com/redirectionlocation.cgi?state","format":"url","type":"string"},"description":"The location to which the cPanel Store or cPanel Market provider\nredirects the user's browser after they log in."}],"description":"This function retrieves the login URL for the cPanel Store or a\ncPanel Market provider.","operationId":"get_login_url","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"payload":{"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","description":"The URL to which to redirect the browser after login.","type":"string"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"get_login_url","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"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"}}}}}}}}},"x-cpanel-available-version":"62","tags":["Authentication","Login URL"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_login_url \\\n  provider='cPStore' \\\n  url_after_login='http://hostname.example.com/redirectionlocation.cgi?state'\n","lang":"Shell","label":"CLI"},{"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","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel Store or cPanel Market login URL"}}},"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"Login URL","description":"Authentication / Login URL"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}]},"delete_cphulk_record":{"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{"ip-address":{"anyOf":[{"format":"ipv4","example":"192.168.0.1","type":"string"},{"type":"string","format":"cidr","example":"192.168.0.1/30"},{"example":"192.168.0.1-192.168.0.2","format":"ipv4-ipv4","type":"string"},{"type":"string","example":"2001:db8::","format":"ipv6"},{"format":"cidr","example":"2001:db8::/32","type":"string"},{"format":"ipv6-ipv6","example":"2001:0db8::-2001:0db8:ffff:ffff:ffff:ffff:ffff:ffff","type":"string"}]}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Management","name":"Management"}],"paths":{"/delete_cphulk_record":{"get":{"parameters":[{"name":"list_name","in":"query","required":"true","description":"The cPHulk list's name.\n\n* `white`\n* `black`","schema":{"enum":["white","black"],"example":"white","type":"string"}},{"required":"true","in":"query","name":"ip","style":"form","description":"The record's IP address.\n\n**Note:**\n\n To delete multiple IP addresses, increment the parameter name. For example, `ip-1`, `ip-2`, `ip-3`.","explode":"true","schema":{"type":"array","items":{"$ref":"#/components/schemas/ip-address"}},"examples":{"single":{"value":["192.168.0.1"],"description":"Single IP address."},"multiple":{"value":["192.168.0.1","192.168.0.2","2001:db8::1","2002:db8::1"],"description":"Multiple IP addresses."}}},{"description":"Whether to skip checking if cPHulk runs on the server.\n\n* `1` - Don’t check cPHulk’s status.\n* `0` - Check cPHulk’s status.\n\n**Note:**\n\n If cPHulk is disabled and you check its status, the function returns the following message:\n`cPHulk is disabled on the server`.","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"in":"query","name":"skip_enabled_check","required":"false"}],"description":"This function deletes a record or records from cPHulk's whitelist or blacklist.","operationId":"delete_cphulk_record","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"delete_cphulk_record","description":"The method name called."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"properties":{"requester_ip":{"format":"ipv4","description":"The requester's IP address.","example":"192.168.0.1","type":"string"},"ips_failed":{"example":{"192.168.9.1":"This is why, beta.","192.168.0.1":"This is why, alpha."},"description":"Information about IP addresses that the system failed to add to the list.","additionalProperties":{"example":"Invalid IP address or range \"192.68.0.1\"","description":"The reason why the system failed to add the IP address to the list.\n\n**Note:**\n\n The IP address is the property name.","type":"string"},"type":"object"},"ips_removed":{"type":"array","description":"The IP addresses that the function removed from the list.","items":{"example":"192.168.0.1","format":"ipv4","type":"string"}},"requester_ip_is_whitelisted":{"example":"1","enum":["0","1"],"description":"Whether the requester's IP address exists on cPHulk's whitelist.\n* `1` - Whitelisted.\n* `0` - **Not** whitelisted.","type":"integer"},"list_name":{"enum":["black","white"],"example":"white","description":"The cPHulk list's name.\n* `black`\n* `white`","type":"string"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11.48","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_cphulk_record \\\n  list_name='white' \\\n  ip='192.168.0.1'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_cphulk_record?api.version=1&list_name=white&ip=192.168.0.1"}],"tags":["cPHulk","Management"],"summary":"Remove login security record from list","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Login Security (cPHulk)","tags":["Management"]}]},"disable_mail_sni":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"paths":{"/disable_mail_sni":{"get":{"parameters":[{"description":"The account's domain. You may pass multiple domains using additional\nnumbered parameters (e.g., `domain-1`, `domain-2`).\n\n**Note:** This parameter has no effect — this function always fails\nregardless of any input because mail SNI can no longer be disabled.","schema":{"example":"example.com","type":"string"},"name":"domain","in":"query","required":"false"}],"operationId":"disable_mail_sni","description":"This function is deprecated and always fails.\n\n**Note:**\n\nMail SNI is **always** enabled. cPanel & WHM no longer allows mail SNI to be disabled.\n\n* Functions that disable Mail SNI fail and make no changes.\n* Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"cPanel & WHM no longer allows mail SNI to be disabled.","description":"The reason the API function failed."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"disable_mail_sni"},"result":{"example":"0","enum":["0"],"description":"This function always returns `0` (failure) because mail SNI\ncan no longer be disabled.\n\n* `0` - Failed.","type":"integer"}}},"data":{"properties":{},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","deprecated":"true","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  disable_mail_sni \\\n  domain='example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_mail_sni?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}],"tags":["Mail","Mail Server Settings"],"summary":"(Deprecated) Disable SNI mail services for domains","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["Mail Server Settings"]}]},"set_market_product_attribute":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"name":"Market","description":"The Market module for WHM API 1."},{"name":"Product Management","description":"cPanel Market / Product Management"}],"paths":{"/set_market_product_attribute":{"get":{"parameters":[{"in":"query","name":"provider","required":"true","description":"The cPanel Market provider's name.","schema":{"type":"string","example":"cPStore"}},{"required":"true","name":"product_id","in":"query","schema":{"example":"12345","type":"string"},"description":"The cPanel Market provider product's name."},{"schema":{"type":"string","example":"price"},"description":"The attribute of the cPanel Market provider's product.\n\n**Note**\n\nAttributes vary between cPanel Market providers and products.","required":"true","name":"attribute","in":"query"},{"description":"The value to set for the attribute.","schema":{"type":"string","example":"6.00"},"name":"value","in":"query","required":"true"}],"operationId":"set_market_product_attribute","description":"This function sets an attribute for a cPanel Market provider's product.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"set_market_product_attribute","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"56","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"},{"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","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Update Market provider product"}}},"x-tagGroups":[{"name":"cPanel Market","tags":["Product Management"]}],"openapi":"3.0.2","info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_current_lts_expiration_status":{"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/get_current_lts_expiration_status":{"get":{"operationId":"get_current_lts_expiration_status","description":"This function determines whether a branch's Long-Term Support (LTS) version expires within three months. For more information about LTS, read our [cPanel Long-Term Support documentation](https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/#more-about-lts).","parameters":[],"x-cpanel-available-version":"62","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"expires_in_next_three_months":{"description":"Whether the LTS version expires within the next three months.\n- `1` — LTS expires within the next three months.\n- `0` — LTS does **not** expire within the next three months.","example":"0","enum":["0","1"],"type":"integer"},"full_version":{"description":"The full version number.","example":"11.88.1.11","type":"string"},"expiration":{"description":"When support for the build version expires.","format":"unix_timestamp","example":"1585612801","type":"integer"}},"type":"object"},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"example":"get_current_lts_expiration_status","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_current_lts_expiration_status\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_current_lts_expiration_status?api.version=1"}],"tags":["Updates"],"summary":"Return Long Term Support expiration status","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Updates module for WHM API 1.","name":"Updates"}]},"listsshkeys":{"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/listsshkeys":{"get":{"parameters":[{"required":"false","name":"files","in":"query","schema":{"example":"TestKey","type":"string"},"description":"A filename, to limit the results to keys that have that filename."},{"description":"Whether to display only public keys.\n\n* `1` — Display only public keys.\n* `0` — Display all keys.","schema":{"enum":["0","1"],"example":"0","type":"integer"},"name":"public","in":"query","required":"false"},{"name":"private","in":"query","required":"false","description":"Whether to display only private keys.\n\n* `1` — Display only private keys.\n* `0` — Display all keys.","schema":{"example":"0","enum":["0","1"],"default":"1","type":"integer"}},{"in":"query","name":"public_texts","required":"false","description":"Whether to include public key text.\n\n* `1` — Include public key text.\n* `0` — Do **not** include public key text.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"}},{"in":"query","name":"private_texts","required":"false","description":"Whether to include private key text.\n\n* `1` — Include private key text.\n* `0` — Do **not** include private key text.","schema":{"enum":["0","1"],"example":"0","default":"1","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.","schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"},"in":"query","name":"sync_authorized","required":"false"}],"operationId":"listsshkeys","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"authorized":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the key is authorized to access the server.\n\n* `1` — Authorized.\n* `0` — **Not** authorized."},"mtime":{"format":"unix_timestamp","description":"The date that the key will expire, in Unix time format.","example":"1416596824","type":"integer"},"comment":{"example":"REPO username@example.com","description":"The key's comment.","type":"string"},"private":{"type":"integer","enum":["0","1"],"example":"1","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."},"ctime":{"type":"integer","format":"unix_timestamp","description":"The date that the key was created, in\n[Unix time format](http://en.wikipedia.org/wiki/Unix_time).","example":"1416596824"},"text":{"example":"ssh-rsaXXXXX3XXXX1XX2XXXXXXXXXXXXXXxXXXX6XXXXX90X41X7XXXXX02XXXXX8XXXX54XXXXXXXXXXX2X07XXXXXXXXXXX7XXXX4XXX2X98XXXX98X80XXXXXXX7X/X4XXXXxX1XXXXXXXXXXXxXXXXXXXXX6+4XXXX36XXXXX3XXXXXX1XXXXXXX/X7+XX1XX6XXXX0XXXXXXX0XXXXXXXX+XxX99X7X2XXXXXX03xXXXXX0XXXXXXXXXX9XXXXXXX9XXXXXXXXXXXX/XXXXX07XXXXX3XXXXXX5XXX+/XXXXXXXXXXXXX3XxXXXXXXXXXXXX6XXXXXXXXXXXX2XXXXXXXXXXXXXXXXX3XX+XXXX3XXXXXXX== REPO username@example.com","description":"The key's text.","type":"string"},"file":{"type":"string","description":"The key's filename.","example":"TestKey"}}},"description":"An array of objects of each key's information."}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"listsshkeys","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"11","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  listsshkeys\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/listsshkeys?api.version=1","lang":"HTTP","label":"URL"}],"tags":["SSH Keys and Connections"],"summary":"Return SSH keys list","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["SSH Keys and Connections"],"name":"Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"description":"Authentication / SSH Keys and Connections","name":"SSH Keys and Connections"}]},"ensure_dkim_keys_exist":{"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"paths":{"/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"}},"schema":{"type":"string"},"name":"domain","in":"query","required":"true"}],"x-cpanel-available-version":"78","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"payload":{"items":{"properties":{"domain":{"type":"string","example":"example.com","format":"domain","description":"The domain for which the system confirmed that a valid DKIM key exists."},"status":{"example":"1","enum":["0","1"],"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.","type":"integer"},"msg":{"description":"The domain's DKIM key status message.","example":"created new key","type":"string"}},"type":"object"},"description":"An array of objects containing information about the domain's DKIM key validity.","type":"array"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed: Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","description":"The method name called.","example":"ensure_dkim_keys_exist"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}}}}}}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ensure_dkim_keys_exist \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ensure_dkim_keys_exist?api.version=1&domain=example.com"}],"tags":["Mail","Mail DNS Settings"],"summary":"Validate domain's DKIM keys","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Mail DNS Settings","description":"Mail / Mail DNS Settings"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"getpkginfo":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"name":"Hosting Plans","tags":["Hosting Plans"]}],"paths":{"/getpkginfo":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"command":{"type":"string","example":"getpkginfo","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"pkg":{"properties":{"CPMOD":{"type":"string","description":"The hosting plan's cPanel interface theme.","example":"jupiter"},"MAXSUB":{"description":"The hosting plan's maximum number of subdomains.\n\n* `unlimited` — The hosting plan allows unlimited subdomains.","example":"5","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited subdomains."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}]},"_PACKAGE_EXTENSIONS":{"type":"string","example":"","description":"A list of one or more of the hosting plan's package extensions, if any exist."},"FEATURELIST":{"description":"The hosting plan's [feature list](https://go.cpanel.net/whmdocsFeatureManager).","example":"myfeaturelist","type":"string"},"HASSHELL":{"description":"Whether shell access is enabled for the hosting plan.\n\n* `1` — Enabled.\n* `0` — Disabled.","example":"1","enum":["1","0"],"type":"integer"},"MAX_TEAM_USERS":{"nullable":"true","example":"7","description":"The hosting plan's maximum number of Team users.","maximum":"7","type":"integer","minimum":"0"},"FRONTPAGE":{"deprecated":"true","description":"Whether Microsoft® FrontPage Extensions are enabled for the account.\n\n**Note:**\n\ncPanel & WHM ignores all FrontPage settings and parameters.","example":"0","enum":["1","0"],"type":"integer"},"MAX_EMAILACCT_QUOTA":{"oneOf":[{"type":"integer","minimum":"1"},{"type":"string","description":"The hosting plan allows an unlimited email account quota size.","enum":["unlimited"]}],"example":"unlimited","description":"The hosting plan's maximum email account quota size, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows an unlimited email account quota size."},"MAXSQL":{"oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited SQL databases."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"description":"The hosting plan's maximum number of SQL databases.\n\n* `unlimited` — The hosting plan allows unlimited SQL databases.","example":"1"},"IP":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether the hosting plan grants accounts a dedicated IP address.\n\n* `1` — Dedicated IP address.\n* `0` — Shared IP address."},"LANG":{"type":"string","format":"ISO-3166-1 (alpha-2)","description":"The hosting plan's locale.","example":"en"},"MAXADDON":{"oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited addon domains."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}],"description":"The hosting plan's maximum number of addon domains.\n\n* `unlimited` — The hosting plan allows unlimited addon domains.","example":"1"},"MAX_EMAIL_PER_HOUR":{"description":"The [maximum number of emails](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send in one hour.\n\n* `unlimited` — The hosting plan allows unlimited emails per hour.","example":"100","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited emails per hour.","enum":["unlimited"],"type":"string"}]},"MAXPARK":{"oneOf":[{"type":"integer","minimum":"0"},{"type":"string","description":"The hosting plan allows unlimited parked domains.","enum":["unlimited"]}],"example":"1","description":"The hosting plan's maximum number of parked domains (aliases).\n\n* `unlimited` — The hosting plan allows unlimited parked domains."},"CGI":{"description":"Whether CGI is enabled for the hosting plan.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":["1","0"],"example":"1","type":"integer"},"DIGESTAUTH":{"description":"Whether the hosting plan enables Digest Authentication.\n\n* `y` — Enabled.\n* `n` — Disabled.","example":"n","type":"string"},"BWLIMIT":{"description":"The hosting plan's bandwidth limit, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows unlimited bandwidth.","example":"unlimited","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited bandwidth."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}]},"MAXPOP":{"description":"The hosting plan's maximum number of email accounts.\n\n* `unlimited` — The hosting plan allows unlimited email accounts.","example":"20","oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited email accounts."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}]},"MAXFTP":{"description":"The hosting plan's maximum number of FTP accounts.\n\n* `unlimited` — The hosting plan allows unlimited FTP accounts.","example":"2","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited FTP accounts."},{"enum":["null"]},{"type":"string","enum":["unlimited"]}]},"MAXLST":{"description":"The hosting plan's maximum number of mailing lists.\n\n* `unlimited` — The hosting plan allows unlimited mailing lists.","example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited mailing lists."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}]},"MAX_DEFER_FAIL_PERCENTAGE":{"example":"10","description":"The\n[percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send per hour before the system rate-limits\noutgoing mail.\n\n* `unlimited` — The hosting plan allows unlimited email messages.","oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited email messages.","enum":["unlimited"],"type":"string"}]},"QUOTA":{"oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan has unlimited disk space."},{"enum":["null"]},{"enum":["unlimited"],"type":"string"}],"description":"The hosting plan's disk space limit, in megabytes (MB).\n\n * `unlimited` — The hosting plan has unlimited disk space.","example":"100"}},"type":"object","description":"A list of the hosting plan's settings.\n\n**Note:**\n\n* The function will only return the package's enabled resources and settings.\n* If the account or its hosting plan use package extensions, the list also\nincludes the extension's variables."}}}}}}}}},"x-cpanel-available-version":"11","parameters":[{"required":"true","in":"query","name":"pkg","schema":{"type":"string","example":"package1"},"description":"The hosting plan's name."}],"description":"This function lists a hosting plan's (package's) settings.","operationId":"getpkginfo","x-cpanel-api-version":"WHM API 1","summary":"Return hosting plan configuration","tags":["Packages","Hosting Plans"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  getpkginfo \\\n  pkg='package1'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/getpkginfo?api.version=1&pkg=package1"}]}}},"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Hosting Plans","description":"Hosting Plans / Hosting Plans"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"remove_zone_key":{"paths":{"/remove_zone_key":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"remove_zone_key","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"86","parameters":[{"in":"query","name":"domain","required":"true","description":"The domain for which to remove a security key.","schema":{"type":"string","example":"example.com"}},{"in":"query","name":"key_id","required":"true","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.","schema":{"example":"1","type":"integer","minimum":"1"}}],"operationId":"remove_zone_key","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.","summary":"Remove DNSSEC key","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  remove_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_zone_key?api.version=1&domain=example.com&key_id=1","lang":"HTTP","label":"URL"}],"tags":["DNS","DNS Security"]}}},"x-tagGroups":[{"tags":["DNS Security"],"name":"DNS"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Security","name":"DNS Security"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"run_cpkeyclt":{"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"License Management","description":"Server Administration / License Management"}],"servers":[{"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."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Server Administration","tags":["License Management"]}],"paths":{"/run_cpkeyclt":{"get":{"operationId":"run_cpkeyclt","description":"This function verifies the system's license status with WebPros International, LLC's\nlicensing servers. To do this, the function runs the `/usr/local/cpanel/cpkeyclt`\nscript.\n\nFor more information about this script and potential license problems,\nread our\n[Installation Guide - Troubleshoot Your Installation](https://docs.cpanel.net/installation-guide/troubleshoot-your-installation/)\ndocumentation.","parameters":[],"x-cpanel-available-version":"62","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","example":"run_cpkeyclt","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["Server Administration","License Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  run_cpkeyclt\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/run_cpkeyclt?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return server's cPanel license status"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}}},"untrack_acct_id":{"paths":{"/untrack_acct_id":{"get":{"parameters":[{"required":"false","in":"query","name":"uid","schema":{"example":"1012","type":"integer"},"description":"The user ID to remove from the track list.\n\n**Note:**\n\n You **must** include the `uid` parameter, the `gid` parameter, or both."},{"schema":{"example":"1012","type":"integer"},"description":"The group ID to remove from the track list.\n\n**Note:**\n\n You **must** include the `uid` parameter, the `gid` parameter, or both.","required":"false","name":"gid","in":"query"},{"required":"false","in":"query","name":"protect_system","schema":{"example":"1","enum":["0","1"],"default":"1","type":"integer"},"description":"Whether to prevent removal of system user or group IDs.\n\n* `1` — Prevent removal.\n* `0` — Do **not** prevent removal."},{"required":"false","name":"check_exists","in":"query","schema":{"enum":["0","1"],"example":"1","default":"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."},{"required":"false","name":"check_quota","in":"query","schema":{"type":"integer","default":"1","example":"1","enum":["0","1"]},"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."}],"operationId":"untrack_acct_id","description":"This function removes a user identification number (UID) or group\nidentification number (GID) from the tracked ID list.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"untrack_acct_id"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"58","tags":["Accounts","Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  untrack_acct_id \\\n  uid='1012'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/untrack_acct_id?api.version=1&uid=1012"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove UID or GID from tracked list"}}},"x-tagGroups":[{"tags":["Account Management"],"name":"Accounts"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"description":"Accounts / Account Management","name":"Account Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"list_rpms":{"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"description":"System Package Management / List Package Information","name":"List Package Information"}],"paths":{"/list_rpms":{"get":{"operationId":"list_rpms","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.","parameters":[{"schema":{"type":"string","example":"3rdparty"},"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.","required":"false","in":"query","name":"target"}],"x-cpanel-available-version":"11.32","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"list_rpms","description":"The method name called.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}},"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"}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["RPM","List Package Information"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  list_rpms\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_rpms?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return required but uninstalled server RPM package"}}},"x-tagGroups":[{"tags":["List Package Information"],"name":"System Package Management"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"remote_mysql_delete_profile":{"x-tagGroups":[{"name":"Databases","tags":["Remote MySQL Databases"]}],"paths":{"/remote_mysql_delete_profile":{"get":{"summary":"Delete remote MySQL profile","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_delete_profile \\\n  name='MyProfile'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_delete_profile?api.version=1&name=MyProfile"}],"tags":["Databases","Remote MySQL Databases"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"example":"remote_mysql_delete_profile","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"profile_deleted":{"type":"string","description":"The deleted profile's name. A valid string.","example":"MyProfile"},"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.","type":"object","properties":{"active":{"type":"integer","description":"Whether the system uses this profile to access the MySQL server.\n- 1  Active.\n- 0  Not active.","enum":["0","1"],"example":"0"},"setup_via":{"type":"string","example":"Main terminal","description":"description of the profile data. A valid string with a maximum length of 255 characters."},"mysql_host":{"type":"string","example":"192.168.0.1","description":"The MySQL server's IP address or hostname. A valid IP address or hostname."},"mysql_user":{"description":"The MySQL server's username. A valid string.","example":"username","type":"string"},"mysql_port":{"description":"The MySQL server's port. A valid positive integer.","example":"3306","type":"integer"},"mysql_pass":{"type":"string","example":"12345luggage","description":"The MySQL server's password. A valid string."}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52","parameters":[{"in":"query","name":"name","required":"true","description":"The profile's name.","schema":{"example":"MyProfile","type":"string"}}],"description":"This function deletes a specified remote MySQL® profile.","operationId":"remote_mysql_delete_profile"}}},"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"Remote MySQL Databases","description":"Databases / Remote MySQL Databases"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"reorder_hooks":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Scripts Hooks"],"name":"Integrations"}],"paths":{"/reorder_hooks":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  reorder_hooks \\\n  ids='HzEpGvT6QGUYwxuX3hWB8AUq,UNs8a8IbbAVf5oi_hXbcEw5a'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/reorder_hooks?api.version=1&ids=HzEpGvT6QGUYwxuX3hWB8AUq%2cUNs8a8IbbAVf5oi_hXbcEw5a","lang":"HTTP","label":"URL"}],"tags":["Script Hooks","Scripts Hooks"],"summary":"Update script hooks order","x-cpanel-api-version":"WHM API 1","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.","schema":{"example":"HzEpGvT6QGUYwxuX3hWB8AUq,UNs8a8IbbAVf5oi_hXbcEw5a","type":"string"},"name":"ids","in":"query","required":"true"}],"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"hook_order":{"items":{"properties":{"weight":{"example":"100","description":"The script hook's weight. The lower the number, the greater the priority.","minimum":"1","type":"integer"},"id":{"example":"HzEpGvT6QGUYwxuX3hWB8AUq","description":"The script hook's ID.","type":"string"}},"type":"object"},"description":"A list of the script hook details.","example":[{"weight":"100","id":"HzEpGvT6QGUYwxuX3hWB8AUq"},{"weight":"200","id":"UNs8a8IbbAVf5oi_hXbcEw5a"}]}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","example":"reorder_hooks","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}}}}}}},"tags":[{"name":"Script Hooks","description":"The Script Hooks module for WHM API 1."},{"description":"Integrations / Scripts Hooks","name":"Scripts Hooks"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}]},"matchpkgs":{"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Hosting Plans / Hosting Plans","name":"Hosting Plans"}],"paths":{"/matchpkgs":{"get":{"tags":["Packages","Hosting Plans"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  matchpkgs\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/matchpkgs?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return filtered hosting plans","parameters":[{"required":"false","name":"MAXSUB","in":"query","schema":{"oneOf":[{"type":"integer","minimum":"0"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows unlimited subdomains."}],"example":"unlimited"},"description":"The hosting plan's maximum number of subdomains.\n\n* `unlimited` — The hosting plan allows unlimited subdomains."},{"required":"false","in":"query","name":"MAXADDON","schema":{"oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited addon domains.","type":"string"}],"example":"unlimited"},"description":"The hosting plan's maximum number of addon domains.\n\n* `unlimited` — The hosting plan allows unlimited addon domains."},{"description":"The\n[percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send per hour before the system rate-limits\noutgoing mail.\n\n* `unlimited` — The hosting plan allows unlimited email messages.","schema":{"example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"description":"The hosting plan allows unlimited email messages.","enum":["unlimited"],"type":"string"}]},"in":"query","name":"MAX_DEFER_FAIL_PERCENTAGE","required":"false"},{"description":"The hosting plan's maximum email account quota size, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows an unlimited email account quota size.","schema":{"oneOf":[{"minimum":"1","type":"integer","format":"megabytes"},{"type":"string","description":"The hosting plan allows an unlimited email account quota size.","enum":["unlimited"]}],"example":"unlimited"},"name":"MAX_EMAILACCT_QUOTA","in":"query","required":"false"},{"schema":{"example":"'ext1 ext2 ext3'","type":"string"},"description":"A space-separated list of one or more of the hosting plan's package extensions.","required":"false","in":"query","name":"_PACKAGE_EXTENSIONS"},{"schema":{"type":"string","example":"jupiter"},"description":"The hosting plan's cPanel interface theme.","required":"false","name":"CPMOD","in":"query"},{"in":"query","name":"MAX_EMAIL_PER_HOUR","required":"false","description":"The [maximum number of emails](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send in one hour.\n\n* `unlimited` — The hosting plan allows unlimited emails per hour.","schema":{"example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited emails per hour.","type":"string"}]}},{"description":"The hosting plan's locale.","schema":{"example":"en","format":"ISO-3166-1 (alpha-2)","type":"string"},"in":"query","name":"LANG","required":"false"},{"description":"The hosting plan's maximum number of mailing lists.\n\n* `unlimited` — The hosting plan allows an unlimited number of mailing lists.","schema":{"example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"type":"string","description":"The hosting plan allows an unlimited number of mailing lists.","enum":["unlimited"]}]},"in":"query","name":"MAXLST","required":"false"},{"schema":{"example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"type":"string","description":"The hosting plan allows unlimited parked domains.","enum":["unlimited"]}]},"description":"The hosting plan's maximum number of parked domains (aliases).\n\n* `unlimited` — The hosting plan allows unlimited parked domains.","required":"false","in":"query","name":"MAXPARK"},{"required":"false","name":"MAXPOP","in":"query","schema":{"example":"unlimited","oneOf":[{"type":"integer","minimum":"0"},{"type":"string","description":"The hosting plan's can create unlimited email accounts.","enum":["unlimited"]}]},"description":"The hosing plan's maximum number of email accounts.\n\n* `unlimited` — The hosting plan's can create unlimited email accounts."},{"description":"The hosting plan's maximum number of SQL databases.\n\n* `unlimited` — The hosting plan allows unlimited SQL databases.","schema":{"oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited SQL databases.","type":"string"}],"example":"unlimited"},"name":"MAXSQL","in":"query","required":"false"},{"schema":{"example":"myfeaturelist","type":"string"},"description":"The hosting plan's [feature list](https://go.cpanel.net/whmdocsFeatureManager).","required":"false","name":"FEATURELIST","in":"query"},{"schema":{"enum":["1","0"],"example":"1","type":"integer"},"description":"Whether shell access is enabled for the hosting plan.\n\n* `1` — Enabled\n* `0` — Disabled.","required":"false","in":"query","name":"HASSHELL"},{"schema":{"example":"1","enum":["1","0"],"type":"integer"},"description":"Whether CGI is enabled for the hosting plan.\n\n* `1` — Enabled.\n* `0` — Disabled.","required":"false","in":"query","name":"CGI"},{"description":"The hosting plan's maximum number of FTP accounts.\n\n* `unlimited` — The hosting plan allows for unlimited FTP accounts.","schema":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows for unlimited FTP accounts."}],"example":"2"},"in":"query","name":"MAXFTP","required":"false"},{"schema":{"oneOf":[{"format":"megabytes","type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited bandwidth.","type":"string"}],"example":"unlimited"},"description":"The hosting plan's bandwidth limit.\n\n* `unlimited` — The hosting plan allows unlimited bandwidth.","required":"false","name":"BWLIMIT","in":"query"},{"required":"false","name":"QUOTA","in":"query","schema":{"oneOf":[{"type":"integer","minimum":"0","format":"megabytes"},{"enum":["unlimited"],"description":"The hosting plan has unlimited disk space.","type":"string"}],"example":"unlimited"},"description":"The hosting plan's disk space limit.\n\n* `unlimited` — The hosting plan has unlimited disk space."},{"required":"false","name":"DIGESTAUTH","in":"query","schema":{"type":"string","example":"n","enum":["y","n"]},"description":"Whether the hosting plan enables Digest Authentication.\n\n* `y` — Enabled.\n* `n` — Disabled."},{"name":"IP","in":"query","required":"false","description":"Whether the hosting plan grants accounts a dedicated IP address.\n\n* `y` — Dedicated IP address.\n* `n` — Shared IP address.","schema":{"enum":["y","n"],"example":"n","type":"string"}},{"required":"false","name":"MAX_TEAM_USERS","in":"query","schema":{"example":"7","nullable":"true","minimum":"0","type":"integer","maximum":"7"},"description":"The hosting plan's maximum number of Team users."}],"operationId":"matchpkgs","description":"This function matches the server's hosting plans (packages) against\nyour criteria.\n\n**Note:**\n\nIf you do not include **any** input parameters, the function lists **all** of\nthe server's packages.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"matchpkgs","description":"The method name called.","type":"string"},"result":{"description":"* `1` – Success.\n* `0` – Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"}}},"data":{"type":"object","properties":{"pkg":{"properties":{"MAXSUB":{"description":"The hosting plan's maximum number of subdomains.\n\n* `unlimited` — The hosting plan allows unlimited subdomains.","example":"5","oneOf":[{"minimum":"0","type":"integer"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows unlimited subdomains."}]},"CPMOD":{"type":"string","description":"The hosting plan's cPanel interface theme.","example":"jupiter"},"FEATURELIST":{"type":"string","example":"myfeaturelist","description":"The hosting plan's\n[feature list](https://go.cpanel.net/whmdocsFeatureManager)."},"HASSHELL":{"description":"Whether shell access is enabled for the hosting plan.\n* `y` — Enabled. * `n` — Disabled.","enum":["y","n"],"example":"n","type":"string"},"_PACKAGE_EXTENSIONS":{"type":"string","description":"A list of one or more of the hosting plan's package extensions.","example":"ext1 ext2 ext3"},"MAX_EMAILACCT_QUOTA":{"oneOf":[{"minimum":"0","type":"integer","format":"megabytes"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows an unlimited email account quota size."}],"description":"The maximum size that the account can define when it\ncreates an email account.\n\n* `unlimited` — The hosting plan allows an unlimited email account quota size.","example":"unlimited"},"FRONTPAGE":{"type":"integer","deprecated":"true","example":"0","enum":["0"],"default":"0","description":"Whether Microsoft® FrontPage Extensions are enabled for the account.\n\n**Note:**\n\ncPanel & WHM ignores all FrontPage settings and parameters."},"IP":{"description":"Whether the hosting plan grants accounts a dedicated IP address.\n\n* `y` — Dedicated IP address.\n* `n` — Shared IP address.","enum":["y","n"],"example":"n","type":"string"},"LANG":{"type":"string","format":"ISO-3166-1 (alpha-2)","description":"The hosting plan's locale.","example":"en"},"MAXSQL":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","description":"The hosting plan allows unlimited SQL databases.","enum":["unlimited"]}],"description":"The hosting plan's maximum number of SQL databases.\n\n* `unlimited` — The hosting plan allows unlimited SQL databases.","example":"1"},"MAXADDON":{"example":"1","description":"The hosting plan's maximum number of addon domains.\n\n* `unlimited` — The hosting plan allows unlimited addon domains.","oneOf":[{"type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited addon domains.","type":"string"}]},"BWLIMIT":{"oneOf":[{"format":"megabytes","type":"integer","minimum":"0"},{"enum":["unlimited"],"description":"The hosting plan allows unlimited bandwidth.","type":"string"}],"example":"unlimited","description":"The hosting plan's bandwidth limit, in megabytes (MB).\n\n* `unlimited` — The hosting plan allows unlimited bandwidth."},"DIGESTAUTH":{"enum":["y","n"],"example":"y","description":"Whether the hosting plan enables Digest Authentication.\n\n* `y` — Enable.\n* `n` — Disable.","type":"string"},"MAX_EMAIL_PER_HOUR":{"description":"The [maximum number of emails](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send in one hour.\n\n* `unlimited` — The hosting plan allows unlimited emails per hour.","example":"100","oneOf":[{"minimum":"0","type":"integer"},{"type":"string","description":"The hosting plan allows unlimited emails per hour.","enum":["unlimited"]}]},"MAXPARK":{"example":"1","description":"The hosting plan's maximum number of parked domains.\n\n* `unlimited` — The hosting plan allows unlimited parked domains.","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited parked domains.","enum":["unlimited"],"type":"string"}]},"CGI":{"description":"Whether CGI is enabled for the hosting plan.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":["1","0"],"example":"1","type":"integer"},"MAX_DEFER_FAIL_PERCENTAGE":{"example":"10","description":"The\n[percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam)\nthat the hosting plan can send per hour before outgoing mail is rate-limited.\n\n* `unlimited` — The hosting plan allows unlimited email messages.","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows unlimited email messages.","enum":["unlimited"],"type":"string"}]},"QUOTA":{"description":"The hosting plan's disk space limit.\n\n* `unlimited` — The hosting plan has unlimited disk space.","example":"100","oneOf":[{"format":"megabytes","type":"integer","minimum":"0"},{"description":"The hosting plan has unlimited disk space.","enum":["unlimited"],"type":"string"}]},"MAXFTP":{"example":"unlimited","description":"The hosting plan's maximum number of FTP accounts.\n\n* `unlimited` — The hosting plan allows for unlimited FTP accounts.","oneOf":[{"minimum":"0","type":"integer"},{"description":"The hosting plan allows for unlimited FTP accounts.","enum":["unlimited"],"type":"string"}]},"MAXPOP":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","description":"The hosting plan's can create unlimited email accounts.","enum":["unlimited"]}],"example":"20","description":"The hosting plan's maximum number of email accounts.\n\n* `unlimited` — The hosting plan's can create unlimited email accounts."},"MAXLST":{"oneOf":[{"minimum":"0","type":"integer"},{"type":"string","enum":["unlimited"],"description":"The hosting plan allows an unlimited number of mailing lists."}],"example":"5","description":"The hosting plan's maximum number of mailing lists.\n\n* `unlimited` — The hosting plan allows an unlimited number of mailing lists."}},"type":"object","description":"A list of hosting plan settings."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"tags":["Hosting Plans"],"name":"Hosting Plans"}]},"modsec_disable_vendor_configs":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"paths":{"/modsec_disable_vendor_configs":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_disable_vendor_configs \\\n  vendor_id='SomeVendor'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor_configs?api.version=1&vendor_id=SomeVendor"}],"tags":["ModSecurity","Rule Vendor Settings"],"summary":"Disable ModSecurity vendor configuration files","x-cpanel-api-version":"WHM API 1","operationId":"modsec_disable_vendor_configs","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.","parameters":[{"required":"true","name":"vendor_id","in":"query","schema":{"example":"SomeVendor","type":"string"},"description":"The vendor's unique short name."}],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"modsec_disable_vendor_configs","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"outcomes":{"type":"array","description":"An array of objects containing elements that represent the outcome of each attempt to disable an operation.","items":{"type":"object","properties":{"ok":{"example":"0","enum":["1","0"],"description":"Whether the function successfully disabled the configuration file.\n\n* `1` — Disabled.\n* `0` — Enabled.","type":"integer"},"active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":["1","0"],"example":"1","type":"integer"},"exception":{"type":"string","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."},"config":{"type":"string","description":"The configuration file path, relative to the `/usr/local/apache/conf/` directory.","example":"modsec_vendor_configs/SomeVendor/example.conf"}}}}},"type":"object"}}}}},"description":"HTTP Request was successful."}}}}}},"edit_hook":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Integrations","tags":["Scripts Hooks"]}],"paths":{"/edit_hook":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"edit_hook","description":"The method name called.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.32","parameters":[{"schema":{"type":"string","example":"HzEpGvT6QGUYwxuX3hWB8AUq"},"description":"The script hook's ID.\n\n**Note:**\n\nTo retrieve a hook's ID, use the WHM API 1 `list_hooks` function.","required":"true","name":"id","in":"query"},{"required":"false","in":"query","name":"check","schema":{"example":"/scripts/postcourier-authlibup","type":"string"},"description":"The absolute file path to the script that runs after the hook script to check the results."},{"required":"false","name":"enabled","in":"query","schema":{"enum":["0","1"],"example":"1","type":"integer"},"description":"Whether the hook script is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled."},{"name":"exectype","in":"query","required":"false","description":"The type of function that the script hook launches.\n\n* `script` — Runs a script.\n* `module` — Calls a function in a module.","schema":{"example":"script","enum":["script","module"],"type":"string"}},{"required":"false","in":"query","name":"hook","schema":{"type":"string","example":"/scripts/postcourier-authlibup"},"description":"The hook script's absolute file path or its `module::subroutine` invocation."},{"required":"false","name":"notes","in":"query","schema":{"example":"Note.","type":"string"},"description":"The script hook's notes."},{"required":"false","in":"query","name":"rollback","schema":{"type":"string","example":"/scripts/postcourier-authlibup"},"description":"The absolute file path to the script that rolls back the hook script."},{"required":"false","in":"query","name":"stage","schema":{"type":"string","example":"post","enum":["pre","post"]},"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."},{"description":"The script hook's priority in the hook's stage, where a lower value runs before a higher value.","schema":{"example":"100","type":"integer","minimum":"1"},"in":"query","name":"weight","required":"false"},{"required":"false","in":"query","name":"escalateprivs","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"},"description":"Whether to escalate privileges to run the hook script as root.\n\n* `1` — Escalate privileges.\n* `0` — Do **not** escalate privileges.\n\n**Note:**\n\n* This parameter **only** applies to script hooks and **not** module hooks.\n* Module hooks cannot escalate privileges."}],"description":"This function edits a script hook.","operationId":"edit_hook","summary":"Update script hook","x-cpanel-api-version":"WHM API 1","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"}],"tags":["Script Hooks","Scripts Hooks"]}}},"tags":[{"description":"The Script Hooks module for WHM API 1.","name":"Script Hooks"},{"description":"Integrations / Scripts Hooks","name":"Scripts Hooks"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}]},"addzonerecord":{"x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}],"paths":{"/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","x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","example":"addzonerecord","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"description":"The 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"}}}}}}},"description":"HTTP Request was successful."}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DnsAddZoneParameterType"}}}},"tags":["DNS","Domain Management"],"x-codeSamples":[{"source":"whmapi1 --input=json --output=jsonpretty \\\n  addzonerecord\n","lang":"Shell","label":"CLI"},{"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","summary":"Create DNS zone record"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"Domain Management","description":"DNS / Domain Management"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"DnsAddZoneParameterTypeCAA":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"type":"object","properties":{"flag":{"type":"integer","description":"Whether the Certificate Authority (CA) will issue an SSL certificate if the CAA resource record contains unknown property tags.\n\n* `0` - The CA will issue an SSL certificate.\n* `1` - The CA will **not** issue an SSL certificate.\n\nFor more information about CAA record flags and property tags, read the [RFC 6844 documentation](https://tools.ietf.org/html/rfc6844#section-3).","enum":["0","1"],"example":"0"},"tag":{"description":"The CAA record's property type.\n\n* `issue` - Authorize a CA to issue a certificate for the domain.\n* `issuewild` - Authorize a CA to issue a wildcard certificate for the domain.\n* `iodef` - Specify a URL to which a CA may report policy violations.","enum":["issue","issuewild","iodef"],"example":"issue","type":"string"},"value":{"description":"The CA's domain or URL. This is a valid [SSL provider](https://sslmate.com/labs/caa/),\n`mailto` URL, or a standard URL.\n\n**Note:**\n\nIf you use `iodef` as the `tag` parameter's value, enter a URL that a CA can use to report issues as this parameter's value.","example":"exampleca.com","type":"string"}}}]},"DnsAddZoneParameterTypeMX":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"type":"object","properties":{"exchange":{"type":"string","description":"The server's location's canonical name (CNAME).","format":"domain","example":"mail.example.com"},"preference":{"type":"integer","description":"The record's priority order.\n\n**Note:**\n\n* Lower values have a higher priority order.\n* For more information about MX records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"10"}}}]},"DnsAddZoneParameterTypeSOA":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"type":"object","properties":{"serial":{"type":"integer","description":"The zone file's revision number.\n\n**Note:**\n\nFor more information about SOA records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","example":"2013122501"},"Lines":{"type":"integer","minimum":"1","example":"4","description":"The number of lines in the SOA section."},"retry":{"description":"The amount of time, in seconds, to wait before the secondary server retries a failed zone transfer.","example":"14400","type":"integer","minimum":"1"},"expire":{"example":"3600000","description":"The amount of time, in seconds, to wait before the secondary server attempts to complete a zone transfer.","minimum":"1","type":"integer"},"rname":{"type":"string","example":"email.host.example.com","description":"The Responsible Person's (RP) email address.\n\n**Note:**\n\n* Replace the `@` symbol with a period (`.`).\n* Do **not** omit any necessary trailing periods."},"mname":{"example":"ns1.host.example.com","format":"domain","description":"The domain's authoritative nameserver.","type":"string"},"refresh":{"type":"integer","minimum":"1","description":"The amount of time, in seconds, to wait before the secondary DNS server queries the primary DNS server's SOA records for changes.","example":"1440"}}}]},"DnsAddZoneParameterTypeAFSDB":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"type":"object","properties":{"subtype":{"type":"integer","example":"1","description":"The 16-bit integer of an AFS cell type.\n\nFor example, specify `1` to signify an AFS version 3.0 Volume Location Server.\n\n**Note:**\n\nFor more information about AFSDB records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183)."},"hostname":{"format":"domain","description":"The database servers' hostname.","example":"hostname.example.com","type":"string"}}}]},"DnsAddZoneParameterTypeNS":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"nsdname":{"type":"string","example":"ns1.example.com","format":"domain","description":"The domain's authoritative nameserver.\n\n**Note:**\n\nFor more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035)."}},"type":"object"}]},"DnsAddZoneParameterType":{"anyOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterTypeA"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeA6"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeAAAA"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeAFSDB"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeALIAS"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeCAA"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeCNAME"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeDNAME"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeDS"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeHINFO"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeLOC"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeMX"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeNS"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypePTR"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeRP"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeSOA"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeSRV"},{"$ref":"#/components/schemas/DnsAddZoneParameterTypeTXT"}],"discriminator":{"propertyName":"type","mapping":{"A":"#/components/schemas/DnsAddZoneParameterTypeA","PTR (Reverse DNS)":"#/components/schemas/DnsAddZoneParameterTypePTR","MX":"#/components/schemas/DnsAddZoneParameterTypeMX","SOA":"#/components/schemas/DnsAddZoneParameterTypeSOA","LOC":"#/components/schemas/DnsAddZoneParameterTypeLOC","CNAME":"#/components/schemas/DnsAddZoneParameterTypeCNAME","CAA":"#/components/schemas/DnsAddZoneParameterTypeCAA","DNAME":"#/components/schemas/DnsAddZoneParameterTypeDNAME","HINFO":"#/components/schemas/DnsAddZoneParameterTypeHINFO","TXT":"#/components/schemas/DnsAddZoneParameterTypeTXT","AAAA":"#/components/schemas/DnsAddZoneParameterTypeAAAA","DS":"#/components/schemas/DnsAddZoneParameterTypeDS","AFSDB":"#/components/schemas/DnsAddZoneParameterTypeAFSDB","ALIAS":"#/components/schemas/DnsAddZoneParameterTypeALIAS","SRV":"#/components/schemas/DnsAddZoneParameterTypeSRV","RP":"#/components/schemas/DnsAddZoneParameterTypeRP","NS":"#/components/schemas/DnsAddZoneParameterTypeNS","A6":"#/components/schemas/DnsAddZoneParameterTypeA6"}}},"DnsAddZoneParameterTypeRP":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"txtdname":{"type":"string","example":"mx1.host.example.com.","format":"domain","description":"The RP's domain name.\n\n**Note:**\n\nDo **not** omit any necessary trailing periods."},"mbox":{"type":"string","description":"The Responsible Person's (RP) email address.\n\n**Note:**\n\n* Replace the `@` symbol with a period (`.`).\n* Do **not** omit any necessary trailing periods.\n* For more information about RP records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183).","example":"user.example.com."}},"type":"object"}]},"DnsAddZoneParameterTypeLOC":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"latitude":{"type":"string","description":"The location's latitude.","example":"41 51 54.305 N"},"size":{"minimum":"1","type":"integer","description":"The diameter of a sphere that encloses the entire location, in meters.","example":"10"},"altitude":{"description":"The location's altitude above sea level, in meters.\n\n**Note:**\n\nMake certain that you append `m` to the altitude value.","example":"178m","type":"string"},"horiz_pre":{"type":"integer","minimum":"1","description":"The location's horizontal precision distance, in meters.","example":"10"},"vert_pre":{"example":"10","description":"The location's vertical precision distance, in meters.","minimum":"1","type":"integer"},"longitude":{"description":"The location's longitude.","example":"87 36 47.95 W","type":"string"},"version":{"enum":["0"],"example":"0","description":"The record's version number.\n\n**Note:**\n\n* You **must** set this value to `0`.\n* For more information about LOC records, read [RFC 1876 at IANA](http://tools.ietf.org/html/rfc1876).","type":"integer"}},"type":"object"}]},"DnsAddZoneParameterTypeA":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"address":{"example":"192.168.0.20","description":"The zone record's IPv4 address.\n\n**Note:**\n\nFor more information about A records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"ipv4","type":"string"}},"type":"object"}]},"DnsAddZoneParameterTypeDNAME":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"type":"object","properties":{"dname":{"type":"string","example":"hostname.example.com","format":"domain","description":"The delegation name (DNAME) alias.\n\n**Note:**\n\nFor more information about DNAME records, read [RFC 2672 at IANA](http://tools.ietf.org/html/rfc2672)."}}}]},"DnsAddZoneParameterTypeA6":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"refer":{"type":"string","deprecated":"true","description":"The record's IPv6 address suffix.\n\n**Note:**\n\nYou **must** uuencode the colons (`:`) in IPv6 addresses in your function calls.","example":"0::0"},"prefix":{"deprecated":"true","example":"48","description":"The record's prefix length.\n\n**Important:**\n\nA6 records are **deprecated**. We **strongly** recommend that you use AAAA records to\nstore IPv6 addresses.","type":"integer","minimum":"1"}},"type":"object"}]},"DnsAddZoneParameterTypeTXT":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"txtdata":{"description":"The TXT record's data.\n\n**Note:**\n\n* This value **must** include beginning and ending quotes (`\"\"`).\n* Do **not** URI-encode the quotes.\n* For more information about TXT records, read [RFC 1464 at IANA](http://tools.ietf.org/html/rfc1464).","example":"\"v=spf1 a -all\"","type":"string"}},"type":"object"}]},"DnsAddZoneParameterTypeHINFO":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"os":{"description":"The host's operating system.","example":"UNIX","type":"string"},"cpu":{"type":"string","description":"The host's CPU type.\n\n**Note:**\n\nFor more information about HINFO records, read [RFC 1700 at IANA](http://tools.ietf.org/html/rfc1700.txt).","example":"INTEL-386"}},"type":"object"}]},"DnsAddZoneParameterTypeALIAS":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"type":"object","properties":{"alias":{"type":"string","example":"hostname.example.com","format":"domain","description":"The hostname you want to point to.\n\n**Note:**\n\nWe strongly recommend that you do not use this function.\nUsing the ALIAS DNS record may result in unexpected behavior, including website downtimes outside of your control, inconsistency in the handling of the record, and security vulnerabilities.\nThis record is only available if you enable access to it and use PowerDNS."}}}]},"DnsAddZoneParameterTypeCNAME":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"flatten":{"type":"integer","description":"Whether to resolve the specified CNAME value with the record's IP address.\n\nIf you do **not** also set the `flatten_to` parameter, the system will attempt to resolve the CNAME automatically.\n\n* `1` - Flattened.\n* `0` - Not flattened (the function will **fail**).\n\n**Note:**\n\nOnly use this parameter when you alter the zone's `root` record.","example":"1","enum":["0","1"]},"flatten_to":{"oneOf":[{"example":"192.0.2.27","format":"ipv4","description":"A valid IPv4 address.","type":"string"},{"example":"2001:0db8:85a3:0042:1000:8a2e:0370:7334","format":"ipv6","description":"A valid IPv6 address.","type":"string"}],"description":"The IP address that the specified CNAME will resolve to.\n\n**Note:**\n\nYou **must** use the `flatten` parameter with this parameter."},"cname":{"example":"hostname.example.com","description":"The canonical name (CNAME) alias.\n\n**Note:**\n\nFor more information about CNAME records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"domain","type":"string"}},"type":"object"}]},"DnsAddZoneParameterTypeSRV":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"weight":{"type":"integer","description":"A relative weight. The system uses this value to rank entries with the same `priority` value.","example":"2"},"target":{"description":"The service's target host.","format":"domain","example":"service.example.com","type":"string"},"port":{"description":"The target host's port.","example":"389","type":"integer"},"priority":{"type":"integer","description":"The target host's priority preference.\n\n**Note:**\n\n* Lower numbers have a higher priority order.\n* For more information about SRV records, read [RFC 2782 at IANA](http://tools.ietf.org/html/rfc2782).","example":"0"}},"type":"object"}]},"DnsAddZoneParameterTypePTR":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"ptrdname":{"description":"A pointer to a canonical name (CNAME).\n\n**Note:**\n\n* Do **not** omit any necessary trailing periods.\n* For more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).","format":"domain","example":"hostname.example.com","type":"string"},"zone":{"type":"string","description":"The new reverse DNS zone's name.","example":"0.168.192.in-addr.arpa"}},"type":"object"}]},"DnsAddZoneParameterTypeDS":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"keyname":{"description":"The record's KeyTag value.\n\n**Note:**\n\nFor more information about DS records, read [RFC 4034 at IANA](http://tools.ietf.org/html/rfc4034).","example":"2642","type":"integer"},"algorithm":{"example":"5","enum":["1","2","3","4","5","7","8","10","13","14","252","253","254"],"description":"The record's algorithm number.\n\n* `1` - RSAMD5\n* `2` - Diffie-Hellman\n* `3` - DSA/SHA-1\n* `4` - Elliptic Curve\n* `5` - RSA/SHA-1\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* `252` - Indirect\n* `253` - Private DNS\n* `254` - Private OID","type":"integer"},"digtype":{"description":"The record's digest type.\n\n* `1` — SHA-1\n* `2` — SHA-256\n* `4` — SHA-384","example":"1","enum":["1","2","4"],"type":"integer"}},"type":"object"}]},"DnsAddZoneParameterBase":{"type":"object","required":["domain","type","line","name","class"],"properties":{"name":{"type":"string","example":"hostname.example.com.","description":"The record's name.\n\n**Note:**\n\nDo **not** omit any necessary trailing periods.\n\nYou **cannot** use this function to add temporary domains.","format":"domain"},"type":{"type":"string","description":"The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types):\n* `A` - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.\n* `A6` - A6 records store IPv6 addresses.\n* `AAAA` - AAAA records store IPv6 addresses.\n* `AFSDB` - AFSDB records store the location of an AFS cell's database servers.\n* `ALIAS` - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.\n* `CAA` - CAA records control which certificate authorities can issue SSL certificates for a domain.\n* `CNAME` - CNAME records create an alias to another hostname.\n* `DNAME` - DNAME records create an alias for a hostname and its subnames.\n* `DS` - DS records specify a record's delegation signer.\n* `HINFO` - HINFO records specify a host's CPU and OS types.\n* `LOC` - LOC records store a hostname's geographical location.\n* `MX` - MX records point a domain name to its MTAs.\n* `NS` - NS records store a domain's authoritative nameservers.\n* `PTR` - PTR records point to a CNAME.\n* `RP` - RP records store a domain's Responsible Person's information.\n* `SOA` - SOA records designate the beginning of a zone of authority.\n* `SRV` - SRV records store the service location records for newer protocols (for example, Autodiscover).\n* `TXT` - TXT records store descriptive text or useful records (for example, SPF or DKIM records).\n\nWhen you call this function, you **must** include the additional parameters for the desired\nzone record type. Select a zone record from the menu to view the required additional\nparameters:","enum":["A","A6","AAAA","AFSDB","ALIAS","CAA","CNAME","DNAME","DS","HINFO","LOC","MX","NS","PTR","RP","SOA","SRV","TXT"],"example":"A"},"domain":{"format":"domain","description":"The new zone record's domain.","example":"example.com","type":"string"},"class":{"oneOf":[{"type":"string","enum":["IN"]},{"description":"A valid DNS record class.","type":"string"}],"example":"IN","description":"The record's class."},"ttl":{"type":"integer","minimum":"1","example":"86400","default":"86400","description":"The record's Time To Live (TTL), in seconds."}}},"DnsAddZoneParameterTypeAAAA":{"allOf":[{"$ref":"#/components/schemas/DnsAddZoneParameterBase"},{"properties":{"address":{"description":"The zone record's IPv6 address.\n\n**Note:**\n\n* You **must** uuencode the colons (`:`) in IPv6 addresses in your function calls.\n* For more information about AAAA records, read [RFC 3596 at IANA](http://tools.ietf.org/html/rfc3596).","format":"ipv6","example":"2001:1:42:1::2a","type":"string"}},"type":"object"}]}}}},"read_cphulk_records":{"paths":{"/read_cphulk_records":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return login security list records","tags":["cPHulk","Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  read_cphulk_records \\\n  list_name='white'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/read_cphulk_records?api.version=1&list_name=white"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"command":{"type":"string","description":"The method name called.","example":"read_cphulk_records"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}},"data":{"properties":{"requester_ip":{"anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}],"description":"The requester's IP address.","example":"10.1.4.228"},"warning_ip":{"type":"string","example":"The IP address is not on the white list.","description":"A localized warning message, if the requester's IP address does not exist on the whitelist."},"requester_ip_is_whitelisted":{"type":"integer","description":"Whether the requester's IP address exists on cPHulk's whitelist.\n* `1` - The IP address exists on the whitelist.\n* `0` - The IP address does not exist on the white list.","enum":["0","1"],"example":"1"},"list_name":{"type":"string","description":"The cPHulk list's name.\n* `black`\n* `white`","enum":["black","white"],"example":"white"},"ips_in_list":{"description":"IP address information.","example":{"DEED::1":"A helpful comment about the IP address.","10.1.4.44":"A helpful comment about the IP address."},"type":"object","additionalProperties":{"example":"A helpful comment about the IP address.","description":"The IP address’s comment.\n\n**Note:**\n\nThe IP address is the return's name.","type":"string"}},"warning_ssh":{"type":"string","description":"A message that explains why you must restart `sshd`.\n\n**Note:**\n\n This return **only** appears if the `restart_ssh` return's value is `1`.","example":"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."},"restart_ssh":{"enum":["0","1"],"example":"1","description":"Whether you must restart `sshd` in order to implement changes.\n\n* `1` — You **must** restart the `sshd` daemon.\n* `0` — The system will implement changes without a restart.\n\n**Note:**\n\nThis return **only** appears if `sshd`’s `UseDNS` setting is enabled. Because `UseDNS` and cPHulk are incompatible, the system disables `UseDNS` when you enable cPHulk.\n* `1` - You must restart `sshd`.\n* `0` - The system will implement changes without a restart.","type":"integer"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.48","parameters":[{"schema":{"type":"string","enum":["black","white"],"example":"white"},"example":"white","description":"The cPHulk list's name.\n\n* `black`\n* `white`","required":"true","name":"list_name","in":"query"},{"description":"Whether to skip checking if cPHulk runs on the server.\n\n**Note:**\n\n If cPHulk is disabled, the function returns the following message:\n`cPHulk is disabled on the server.`","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"name":"skip_enabled_check","in":"query","required":"false"}],"operationId":"read_cphulk_records","description":"This function displays a cPHulk list's records."}}},"x-tagGroups":[{"tags":["Management"],"name":"Login Security (cPHulk)"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"name":"Management","description":"Login Security (cPHulk) / Management"}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"remove_in_progress_exim_config_edit":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Mail","tags":["Mail Server Settings"]}],"paths":{"/remove_in_progress_exim_config_edit":{"get":{"operationId":"remove_in_progress_exim_config_edit","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.","parameters":[],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The 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"},"command":{"description":"The method name called.","example":"remove_in_progress_exim_config_edit","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason field for more details.","example":"1","enum":["0","1"]}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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"}],"tags":["Server Administration","Mail Server Settings"],"summary":"Remove Exim configuration files after failed update","x-cpanel-api-version":"WHM API 1"}}}},"get_transfer_session_state":{"paths":{"/get_transfer_session_state":{"get":{"tags":["Transfers","Transfer Monitoring"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_transfer_session_state \\\n  transfer_session_id='exampleservercopya20140206192428NtyW'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_transfer_session_state?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW"}],"x-cpanel-api-version":"WHM API 1","summary":"Return transfer session's status","parameters":[{"schema":{"type":"string","example":"exampleservercopya20140206192428NtyW"},"description":"The transfer session's ID.","required":"true","name":"transfer_session_id","in":"query"}],"description":"This function retrieves the state of a transfer session.\n\n**Note:**\n\nFor more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","operationId":"get_transfer_session_state","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","example":"get_transfer_session_state","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"state_name":{"type":"string","enum":["TRANSFER_PENDING","TRANSFER_INPROGRESS","RESTORE_PENDING","RESTORE_INPROGRESS","RUNNING","PAUSED","PENDING","COMPLETED","ABORTED","FAILED"],"example":"TRANSFER_INPROGRESS","description":"The transfer session's state.\n* `TRANSFER_PENDING`\n* `TRANSFER_INPROGRESS`\n* `RESTORE_PENDING`\n* `RESTORE_INPROGRESS`\n* `RUNNING`\n* `PAUSED`\n* `PENDING`\n* `COMPLETED`\n* `ABORTED`\n* `FAILED`"}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"11.44"}}},"x-tagGroups":[{"name":"Transfers","tags":["Transfer Monitoring"]}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"description":"Transfers / Transfer Monitoring","name":"Transfer Monitoring"}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"create_cpgreylist_trusted_host":{"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"paths":{"/create_cpgreylist_trusted_host":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"comment":{"description":"Comment for the batch.","example":"NoComment","type":"string","maxLength":"255"},"ips_failed":{"description":"An object that contains the IP addresses that the function failed to add to the Trusted Hosts list.","properties":{"comment":{"example":"Sorry, 192.168 is not a valid IP address.","description":"The reason for the failure.","type":"string"}},"type":"object"},"ips_added":{"type":"array","items":{"properties":{"create_time":{"type":"string","format":"ISO-8601 Date Time (Space Separated)","description":"The date and time at which the function created the record.","example":"2015-02-17T10:08:26.000Z"},"host_ip":{"format":"ipv4","description":"The trusted host's IP address.","example":"192.168.0.1","type":"string"},"comment":{"description":"Comment for the individual record.","example":"Fascinating","maxLength":"255","type":"string"},"id":{"type":"integer","minimum":"1","example":"42","description":"The host's record number."}},"type":"object"},"description":"An array of objects that contains the IP addresses that the function added to the Trusted Hosts list."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","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.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"create_cpgreylist_trusted_host","description":"The method name called.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.50","parameters":[{"examples":{"single":{"summary":"To add a single IP address.","value":"192.168.0.1"},"multiple":{"summary":"To add multiple IP addresses.","value":"ip-1=192.168.0.1&ip-2=192.168.0.2&ip-3=192.168.0.3"}},"description":"The record's IP address, or a range of IP addresses.\n\n**Note:**\n\nTo add multiple IP addresses, increment the parameter name. For example, `ip-1`, `ip-2`, and `ip-3`.","schema":{"example":"192.168.0.1","type":"string"},"in":"query","name":"ip","required":"true"},{"required":"false","in":"query","name":"comment","schema":{"example":"NoComment","type":"string","maxLength":"255"},"description":"A comment."}],"operationId":"cPGreyList-create_cpgreylist_trusted_host","description":"This function adds an IP address to the *Greylisting Trusted Hosts* list.","x-cpanel-api-version":"WHM API 1","summary":"Add IP address to Greylisting trusted hosts","tags":["Greylisting","Spam Protection (Greylisting)"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  create_cpgreylist_trusted_host \\\n  ip='192.168.0.1'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/create_cpgreylist_trusted_host?api.version=1&ip=192.168.0.1","lang":"HTTP","label":"URL"}]}}},"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"servers":[{"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."}},"description":"A server running WHM."}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"update_nameservers_config":{"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"Resolvers","description":"DNS / Resolvers"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Resolvers"],"name":"DNS"}],"paths":{"/update_nameservers_config":{"get":{"parameters":[{"name":"nameserver","in":"query","required":"false","description":"The nameserver to add or update as the `wwwacct.conf` file's `NS` setting. If you do not supply a value, the function does not update the setting.","schema":{"type":"string","example":"ns1.example.com","format":"domain"}},{"name":"nameserver2","in":"query","required":"false","description":"The nameserver to add or update as the `wwwacct.conf` file's `NS2` setting. If you do not supply a value, the function does not update the setting.","schema":{"type":"string","example":"ns2.example.com","format":"domain"}},{"description":"The nameserver to add or update as the `wwwacct.conf` file's `NS3` setting. If you do not supply a value, the function does not update the setting.","schema":{"format":"domain","example":"ns3.example.com","type":"string"},"in":"query","name":"nameserver3","required":"false"},{"in":"query","name":"nameserver4","required":"false","description":"The nameserver to add or update as the `wwwacct.conf` file's `NS4` setting. If you do not supply a value, the function does not update the setting.","schema":{"example":"ns4.example.com","format":"domain","type":"string"}}],"description":"This function updates nameservers in the `wwwacct.conf` file. For more information, read our [Installation Guide - Customize Your Installation](https://go.cpanel.net/advancedinstall) documentation.","operationId":"update_nameservers_config","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"update_nameservers_config","description":"The method name called.","type":"string"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}}}}}}}},"x-cpanel-available-version":"76","tags":["DNS","Resolvers"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_nameservers_config\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/update_nameservers_config?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Update default nameservers"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"fetchsslinfo":{"x-tagGroups":[{"tags":["cPanel Account Settings"],"name":"SSL Certificates"}],"paths":{"/fetchsslinfo":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetchsslinfo","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"searched_users":{"type":"array","example":["root","example"],"description":"A list of users that the system searched to find certificate information.","items":{"type":"string","format":"username"}},"crt":{"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-----","description":"The certificate's text.","type":"string"},"user":{"type":"string","example":"example","format":"username","description":"The certificate's owner."},"key":{"type":"string","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-----","description":"The certificate's private key."},"domain":{"example":"example.com","format":"domain","description":"The domain name on the certificate.","type":"string"},"crt_origin":{"type":"string","format":"username","description":"The username of the certificate's creator.","example":"example"},"cab":{"type":"string","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-----"},"key_origin":{"type":"string","example":"example","format":"username","description":"The username of the key's creator."},"ip":{"type":"string","format":"ipv4","description":"The certificate's IP address.","example":"192.168.0.20"}},"type":"object"}}}}}}},"x-cpanel-available-version":"11.32","parameters":[{"description":"The domain's name.","schema":{"type":"string","format":"domain","example":"example.com"},"in":"query","name":"domain","required":"false"},{"schema":{"type":"string","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-----"},"description":"The certificate's text.","required":"false","in":"query","name":"crtdata"}],"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","summary":"Return cPanel account SSL certificate information","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetchsslinfo\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/fetchsslinfo?api.version=1","lang":"HTTP","label":"URL"}],"tags":["SSL","cPanel Account Settings"]}}},"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"lookupnsips":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / Resolvers","name":"Resolvers"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Resolvers"],"name":"DNS"}],"paths":{"/lookupnsips":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return nameserver's IPv4 and IPv6 addresses","tags":["DNS","Resolvers"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  lookupnsips \\\n  host='ns1.example.com'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/lookupnsips?api.version=1&host=ns1.example.com","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"60","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"ipv6":{"example":"2001:0db8:0:0:1:0:0:1","format":"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.","type":"string"},"ipv4":{"type":"string","example":"192.0.2.0","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.","format":"ipv4"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."},"command":{"type":"string","example":"lookupnsips","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"operationId":"lookupnsips","description":"This function retrieves a nameserver's IPv4 and IPv6 addresses.","parameters":[{"in":"query","name":"host","required":"true","description":"The nameserver's hostname.","schema":{"example":"ns1.example.com","type":"string"}}]}}}},"getresellerips":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"x-tagGroups":[{"tags":["Account Settings"],"name":"Resellers"}],"paths":{"/getresellerips":{"get":{"tags":["Resellers","Account Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","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","summary":"Return reseller's available IP addresses","parameters":[{"required":"false","name":"user","in":"query","schema":{"example":"username","format":"username","type":"string"},"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."}],"operationId":"getresellerips","description":"This function lists a reseller's available IP addresses.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"all":{"type":"integer","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"},"ip":{"description":"The reseller's available IP addresses.","items":{"type":"string","format":"ipv4","example":"192.168.0.20"},"type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"getresellerips"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}},"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"name":"Account Settings","description":"Resellers / Account Settings"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"fetch_security_advice":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"tags":[{"name":"Security","description":"The Security module for WHM API 1."}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Server Administration","tags":["Security"]}],"paths":{"/fetch_security_advice":{"get":{"responses":{"200":{"content":{"application/json":{"examples":{"advice_with_module_error":{"value":{"metadata":{"reason":"OK","result":"1","version":"1","command":"fetch_security_advice"},"data":{"payload":[{"type":"mod_advice","advice":{"key":"SSH_direct_root_login_permitted","type":"ADVISE_BAD","summary":"SSH direct root logins are permitted.","suggestion":"Manually edit /etc/ssh/sshd_config and change PermitRootLogin to “without-password” or “no”, then restart SSH …"},"module":"Cpanel::Security::Advisor::Assessors::SSH"},{"module":"Cpanel::Security::Advisor::Assessors::SSH","type":"mod_advice","advice":{"key":"SSH_is_current","summary":"Current SSH version is up to date: 11.22p33-44","type":"ADVISE_GOOD","suggestion":null}},{"message":"Anvil not found at /usr/local/cpanel/Cpanel/Security/Advisor/Assessors/ACME.pm line 6.","type":"mod_load","module":"Cpanel::Security::Advisor::Assessors::ACME"}]}}}},"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"example":"fetch_security_advice","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}},"data":{"type":"object","properties":{"payload":{"description":"**Note:**\n\n * This function only returns the the `advice` array of objects when the `type` return is the `mod_advice` value.\n * This function only returns the `message` return when the `type` return is the `mod_load` or `mod_run` value.","items":{"type":"object","properties":{"module":{"example":"Cpanel::Security::Advisor::Assessors::ClamAV","description":"The name of a module that the Security Advisor checked.","type":"string"},"advice":{"description":"**Note:**\n\n  This function only returns this object when the `type` return is the `mod_advice` value.","type":"object","properties":{"key":{"type":"string","description":"A unique check identifier in the module that returns a status message.","example":"ClamAV_not_installed"},"type":{"type":"string","enum":["ADVISE_BAD","ADVISE_GOOD","ADVISE_INFO","ADVISE_WARN"],"example":"ADVISE_BAD","description":"The level at which the module returns a specific security message.\n* `ADVISE_BAD` - The object contains a security issue.\n* `ADVISE_GOOD` - There are no security issues.\n* `ADVISE_INFO` - The object contains an informational message.\n* `ADVISE_WARN` - The object contains a warning."},"summary":{"format":"HTML","description":"A summary about the module's current security status.","example":"ClamAV is not installed.","type":"string"},"suggestion":{"format":"HTML","description":"A message that suggests how to resolve the security issue.","example":"Install ClamAV within \"<a target=\\\"_blank\\\" href=\\\"https://example.com:2087/scripts2/manage_plugins\\\">Manage Plugins</a>\".","nullable":"true","type":"string"}}},"type":{"enum":["mod_advice","mod_load","mod_run"],"example":"mod_advice","description":"The type of security message.\n\n* `mod_advice` - There is a message from the Security Advisor module.\n* `mod_load` - There was an error preventing the loading of the module.\n* `mod_run` - There was an error preventing the system from completing one of the module's checks.","type":"string"},"message":{"type":"string","description":"A message that describes an error.\n\n**Note:**\n\n  This function only returns this value for the `type` return's `mod_load` and `mod_run` values.","example":"Can't call method \"get_raw_conf\" on an undefined value at /usr/local/cpanel/Whostmgr/Services/SSH/Config.pm line 160."}}},"type":"array"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"80","parameters":[],"description":"This function returns the cPanel Security Advisor's security scan data. It advises you of how to resolve any security issues that it finds.\n\n**Note:**\n\n  For more information, read the [cPanel Security Advisor](https://go.cpanel.net/githubsecurityadvisor) documentation at the WebPros International, LLC GitHub® repository.","operationId":"fetch_security_advice","summary":"Return Security Advisor results","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetch_security_advice\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_security_advice?api.version=1"}],"tags":["Security"]}}}},"backup_config_set":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"tags":["Backup Settings"],"name":"Backups"}],"paths":{"/backup_config_set":{"get":{"tags":["Backups","Backup Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  backup_config_set\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_config_set?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Update the system's backup configuration","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.","schema":{"default":"1","enum":["0","1"],"example":"1","type":"integer"},"in":"query","name":"backup_daily_enable","required":"false"},{"in":"query","name":"backup_daily_retention","required":"false","description":"The number of daily backups to retain.","schema":{"minimum":"0","type":"integer","default":"5","example":"5"}},{"name":"backup_monthly_dates","in":"query","required":"false","description":"Which days of the month to run backups.\n\n**Note:**\n\nTo add multiple days, use a comma-delimited list.","schema":{"default":"1","example":"1","type":"integer","maximum":"31","minimum":"1"}},{"name":"backup_monthly_enable","in":"query","required":"false","description":"Whether to enable monthly backups.\n\n* `1` — Enable.\n* `0` — Disable.","schema":{"type":"integer","example":"0","enum":["0","1"],"default":"0"}},{"required":"false","name":"backup_monthly_retention","in":"query","schema":{"default":"1","example":"5","type":"integer","minimum":"0"},"description":"The number of monthly backups to retain."},{"schema":{"type":"integer","maximum":"6","minimum":"1","default":"0","example":"1"},"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.","required":"false","in":"query","name":"backup_weekly_day"},{"description":"Whether to enable weekly backups.\n\n* `1` — Enable.\n* `0` — Disable.","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"in":"query","name":"backup_weekly_enable","required":"false"},{"name":"backup_weekly_retention","in":"query","required":"false","description":"The number of weekly backups to retain.","schema":{"example":"4","default":"4","type":"integer","minimum":"0"}},{"required":"false","in":"query","name":"backupaccts","schema":{"enum":["0","1"],"example":"1","default":"1","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."},{"required":"false","name":"backupbwdata","in":"query","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"1"},"description":"Whether to back up bandwidth tracking data.\n\n* `1` — Back up.\n* `0` — Do **not** back up."},{"name":"backupdays","in":"query","required":"false","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.","schema":{"type":"string","maximum":"6","minimum":"0","default":"0,2,4,6","example":"0,1,2,3,4,5,6"}},{"schema":{"type":"string","example":"/backup","default":"/backup"},"description":"The primary backup directory.","required":"false","in":"query","name":"backupdir"},{"required":"false","name":"backupenable","in":"query","schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"},"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":"backupfiles","required":"false","description":"Whether to back up system files.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","schema":{"example":"1","enum":["0","1"],"default":"1","type":"integer"}},{"schema":{"default":"0","enum":["0","1"],"example":"0","type":"integer"},"description":"Whether to back up the error logs.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","required":"false","name":"backuplogs","in":"query"},{"in":"query","name":"backupmount","required":"false","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.","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"}},{"schema":{"type":"integer","default":"0","enum":["0","1"],"example":"0"},"description":"Whether to back up suspended accounts.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","required":"false","name":"backupsuspendedaccts","in":"query"},{"description":"The type of backup to create.\n\n* `compressed`\n* `uncompressed`\n* `incremental`","schema":{"default":"compressed","enum":["compressed","uncompressed","incremental"],"example":"compressed","type":"string"},"name":"backuptype","in":"query","required":"false"},{"required":"false","in":"query","name":"check_min_free_space","schema":{"type":"integer","default":"1","enum":["0","1"],"example":"1"},"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."},{"name":"disable_metadata","in":"query","required":"false","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.","schema":{"default":"0","enum":["0","1"],"example":"0","type":"integer"}},{"schema":{"minimum":"0","type":"integer","example":"3","default":"3"},"description":"The number of times that the system will try to use the additional backup destination.","required":"false","name":"errorthreshhold","in":"query"},{"required":"false","in":"query","name":"force_prune_daily","schema":{"example":"0","enum":["0","1"],"default":"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."},{"name":"force_prune_monthly","in":"query","required":"false","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.","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"}},{"in":"query","name":"force_prune_weekly","required":"false","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.","schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"}},{"description":"The `gzip` environment variables.","schema":{"type":"string","default":"","example":"--rysncable"},"in":"query","name":"gziprsyncopts","required":"false"},{"required":"false","in":"query","name":"keeplocal","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"1"},"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":"linkdest","required":"false","description":"Whether to check the `rsync` function for hardlink support.\n\n* `1` — Check.\n* `0` — Do **not** check.","schema":{"default":"0","example":"0","enum":["0","1"],"type":"integer"}},{"name":"localzonesonly","in":"query","required":"false","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`.","schema":{"default":"0","enum":["0","1"],"example":"0","type":"integer"}},{"required":"false","in":"query","name":"maximum_restore_timeout","schema":{"minimum":"0","type":"integer","example":"21600","default":"21600"},"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."},{"required":"false","name":"maximum_timeout","in":"query","schema":{"default":"7200","example":"7200","type":"integer","minimum":"0"},"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."},{"required":"false","in":"query","name":"min_free_space","schema":{"default":"5","example":"1024","type":"integer","minimum":"0"},"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`."},{"required":"false","in":"query","name":"min_free_space_unit","schema":{"type":"string","enum":["MB","percent"],"example":"MB","default":"percent"},"description":"The units of measurement of disk space for the `min_free_space` return.\n\n* `MB` — Megabytes.\n* `percent` — Percent available."},{"schema":{"example":"accounts","enum":["accounts","dir","both"],"default":"accounts","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.","required":"false","name":"mysqlbackup","in":"query"},{"schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"description":"Whether to run the `/usr/local/cpanel/scripts/postcpbackup` script after\nthe backup finishes.\n\n* `1` — Run.\n* `0` — Do **not** run.","required":"false","name":"postbackup","in":"query"},{"name":"prebackup","in":"query","required":"false","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.","schema":{"default":"1","enum":["0","1"],"example":"1","type":"integer"}},{"in":"query","name":"psqlbackup","required":"false","description":"Whether to back up PostgreSQL® databases.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","schema":{"default":"0","example":"0","enum":["0","1"],"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.","schema":{"type":"string","example":"/backup"},"name":"remote_restore_staging_dir","in":"query","required":"false"}],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","example":"backup_config_set","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}}}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Settings","description":"Backups / Backup Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"modify_account_enhancement":{"tags":[{"description":"The Account Enhancement module for WHM.","name":"AccountEnhancement"},{"name":"Account Enhancements","description":"Accounts / Account Enhancements"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"name":"Accounts","tags":["Account Enhancements"]}],"paths":{"/modify_account_enhancement":{"get":{"summary":"Update Account Enhancement","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  modify_account_enhancement \\\n  name='enhancement 5000' \\\n  id='sample-enhancement-id'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modify_account_enhancement?api.version=1&name=enhancement%205000&id=sample-enhancement-id"}],"tags":["Account Enhancements"],"x-cpanel-available-version":"11.98","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"name":{"type":"string","description":"The enhancement name.","example":"Sample Enhancement"},"id":{"description":"The updated enhancement id.","example":"sample-enhancement-id","type":"string"}}},"metadata":{"properties":{"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":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The name of the method called.","example":"modify_account_enhancement","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function modifies an account enhancement.\n\n**Important:**\n\n* When you call this function, you **must** include at least one of\nthe `id` or `name` parameters. Lack of a second parameter will result\nin no change.","operationId":"modify_account_enhancement","parameters":[{"required":"true","in":"query","name":"name","schema":{"example":"enhancement 5000","type":"string"},"description":"The name of the account enhancement."},{"schema":{"type":"string","example":"sample-enhancement-id"},"description":"The account enhancement's new identifier.\n\n**Note:**\n* You must use an [account enhancements](https://go.cpanel.net/account-enhancements) ID that a 3rd-party plugin defines.\n* To return a list of valid account enhancement IDs, run the WHM API 1 `list_account_enhancements` function.","required":"false","name":"id","in":"query"}]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.97.0.9999","description":"WHM API."}},"configurebackgroundprocesskiller":{"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Services","description":"Server Administration / Services"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Services"],"name":"Server Administration"}],"paths":{"/configurebackgroundprocesskiller":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update background process stopper","tags":["Server Administration","Services"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  configurebackgroundprocesskiller \\\n  processes_to_kill='eggdrop'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/configurebackgroundprocesskiller?api.version=1&processes_to_kill=eggdrop"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","description":"The method name called.","example":"configurebackgroundprocesskiller"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"11","parameters":[{"required":"true","name":"processes_to_kill","in":"query","schema":{"type":"string"},"description":"A process to kill in the `/usr/local/cpanel/etc/sym` directory.\n\n**Note:**\n\nTo enable the background killer for multiple processes, duplicate or increment the parameter name.\n\nFor example, `processes_to_kill`, `processes_to_kill-0`, and `processes_to_kill-1`.","examples":{"multiple":{"summary":"Kill multiple processes.","value":"eggdrop-0, eggdrop-1, eggdrop-2"},"single":{"value":"eggdrop","summary":"Kill a single process."}}},{"in":"query","name":"trusted_users","required":"false","description":"Unaffected users. If you do not specify a value, the function affects all of the users on the server.\n\n**Note:**\n\nTo trust multiple users, duplicate or increment the parameter name.\n\nFor example, `trusted_users`, `trusted_users-0`, and `trusted_users-1`.","schema":{"type":"string","example":"user"}}],"description":"This function configures the server's background process killer.","operationId":"configurebackgroundprocesskiller"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"set_default_dmarc_record":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.123.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"paths":{"/set_default_dmarc_record":{"get":{"parameters":[{"required":"false","name":"record","in":"query","schema":{"type":"string"},"examples":{"remove":{"value":"","summary":"Remove custom default (empty string)"},"basic":{"value":"v=DMARC1; p=none;","summary":"A basic DMARC record with none policy"}},"description":"The DMARC record to set as the server default.\n\n**Note:**\n\nThe record must be a valid DMARC record that starts with `v=DMARC1;` and contains a policy directive (p=none, p=quarantine, or p=reject).\n\nPass an empty string to remove the custom default and revert to the built-in default.\n\nVisit the following link for more information about the DMARC record specification: https://dmarc.org/resources/specification/."}],"description":"This function sets the server's default DMARC record.\n\nThe system uses the default DMARC record when creating new accounts or applying DMARC policies that don't specify a custom record.\n\n**Note:**\n\n You can pass an empty string to remove the custom default and revert to the built-in default record.","operationId":"EmailAuth::set_default_dmarc_record","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payload":{"description":"An object that contains the operation result.","properties":{"success":{"type":"integer","description":"Indicates whether the operation was successful.\n* `1` - The default DMARC record was set successfully.","example":"1"}},"type":"object"}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"set_default_dmarc_record"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"124","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  set_default_dmarc_record \\\n  record='v=DMARC1; p=quarantine; rua=mailto:dmarc-reports@example.com;'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_default_dmarc_record?api.version=1&record=v%3DDMARC1%3B%20p%3Dquarantine%3B%20rua%3Dmailto%3Admarc-reports%40example.com%3B","label":"URL","lang":"HTTP"}],"tags":["Mail","Mail DNS Settings"],"summary":"Set the server's default DMARC record","x-cpanel-api-version":"WHM API 1"}}}},"twofactorauth_get_tfa_config_for_user":{"openapi":"3.0.2","info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.117.0.9999","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"}],"paths":{"/twofactorauth_get_tfa_config_for_user":{"get":{"x-cpanel-available-version":"118","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"additionalProperties":{"type":"object","properties":{"team":{"description":"The cPanel user's team user account data.","additionalProperties":{"description":"An objection that contains a hash of the team user account's data.","type":"object","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}}},"type":"object"},"primary_account":{"properties":{"secret":{"description":"The 2FA secret for the account.","type":"string"}},"type":"object","description":"An object containing the secret for the cPanel user if 2FA is enabled for the user."},"email":{"description":"The email data for the user.","type":"object","additionalProperties":{"description":"An object that contains a hash of the email account's data.","properties":{"secret":{"example":"QLLIU5WTY3UTJGNG","description":"The 2FA secret for the account.","type":"string"}},"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":{"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"twofactorauth_get_tfa_config_for_user","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"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.","schema":{"example":"example","format":"username","type":"string"},"name":"user","in":"query","required":"true"}],"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_get_tfa_config_for_user?api.version=1&user=user","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}]},"get_lts_wexpire":{"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/get_lts_wexpire":{"get":{"parameters":[],"description":"This function parses the `/etc/cpanel/TIERS.json` file and returns whether a branch qualifies for Long-Term Support (LTS). For more information about LTS, read our [cPanel Long-Term Support](https://go.cpanel.net/cpanel-lts) documentation.","operationId":"get_lts_wexpire","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"branch":{"type":"object","additionalProperties":{"items":{"type":"object","properties":{"is_main":{"description":"Whether the build represents the main build of the branch.\n* `1` - The build is the main build of the branch.\n* `0` - The build is **not** the main build of the branch.\n\n**Note:**\n\nThis will be `1` for exactly one of the entries in this array.","enum":["0","1"],"example":"0","type":"integer"},"build":{"type":"string","description":"The build version number.","example":"11.90.0.5"}}},"description":"The branch.","type":"array"},"description":"An object that lists information about available branch builds.","example":{"11.88.0":[{"is_main":"1","build":"11.88.0.14"}],"11.78.0":[{"is_main":"1","build":"11.78.0.49"}],"11.90.0":[{"is_main":"1","build":"11.90.0.5"}],"11.86.0":[{"is_main":"1","build":"11.86.0.25"}],"11.84.0":[{"is_main":"1","build":"11.84.0.22"}],"11.82.0":[{"build":"11.82.0.19","is_main":"1"}],"11.80.0":[{"build":"11.80.0.24","is_main":"1"}]}},"flags":{"additionalProperties":{"enum":["0","1"],"description":"Feature or flag in the output format.\n\n* `1` - Feature is present in the returned data.\n* `0` - Feature is **not** present in the returned data.","type":"integer"},"type":"object","example":{"is_main":"1"},"description":"An object containing Features or flags supported by this output."},"tiers":{"description":"An object that lists information about build versions in release tiers.","example":{"11.82":[{"is_main":"1","build":"11.82.0.19"}],"11.80":[{"is_main":"1","build":"11.80.0.24"}],"11.78":[{"is_main":"1","build":"11.78.0.49","expires":"1588636799","is_lts":"1"}],"11.90":[{"named":["current","edge","release"],"build":"11.90.0.5","is_main":"1"}],"11.86":[{"expires":"1617148801","build":"11.86.0.25","is_main":"1","is_lts":"1","named":["lts"]}],"11.84":[{"is_main":"1","build":"11.84.0.22"}],"11.88":[{"named":["stable"],"is_main":"0","build":"11.88.0.13"},{"is_main":"1","build":"11.88.0.14"}]},"additionalProperties":{"description":"The release tier.","items":{"properties":{"expires":{"type":"string","description":"When WebPros International, LLC support for the build version expires.\nEncoded as a Unix Timestamp.\n\n**Note:**\n\nThis item is only present when the version is LTS.","example":"1617148801"},"build":{"type":"string","description":"The build version number."},"is_main":{"type":"integer","description":"Whether the build represents the main build of the tier.\n* `1` - The build is the main build of the tier.\n* `0` - The build is **not** the main build of the tier.\n\n**Note:**\n\nThis will be `1` for exactly one of the entries in this array.","enum":["0","1"],"example":"1"},"is_lts":{"type":"integer","description":"Whether cPanel offers this version as LTS.\n* `1` — Long-term support.\n* `0` — No Long-term support.\n\n**Note:**\n\nThis item is only present when the version is LTS.","enum":["1"],"example":"1"},"named":{"type":"array","example":["edge","current","release"],"items":{"type":"string","enum":["edge","current","release","stable","lts"]},"description":"The release tier or tiers which currently offer this branch, if applicable.\n\n**Note:**\n\nThis item is only present when the version is part of a named tier."}},"type":"object"},"type":"array"},"type":"object"}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"get_lts_wexpire","description":"The method name called."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"62","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_lts_wexpire\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_lts_wexpire?api.version=1"}],"tags":["Updates"],"summary":"Return Long Term Support status for all versions","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Server Administration","tags":["Updates"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Updates module for WHM API 1.","name":"Updates"}]},"get_upgrade_opportunities":{"paths":{"/get_upgrade_opportunities":{"get":{"tags":["Accounts","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_upgrade_opportunities\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_upgrade_opportunities?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Get upgrade opportunities","operationId":"get_upgrade_opportunities","description":"This function lists accounts that could benefit from upgrading to a different package.\nThe listed accounts may be nearing (or exceeding) resource usage thresholds.","parameters":[{"schema":{"exclusiveMaximum":"true","minimum":"0","type":"number","exclusiveMinimum":"true","maximum":"1","default":"0.8","example":"0.6"},"description":"The fraction of 1 at which to consider usage \"near\".","required":"false","name":"nearness_fraction","in":"query"},{"in":"query","name":"disk_threshold_blocks","required":"false","description":"A fixed number of blocks to use as an alternative disk usage threshold.","schema":{"example":"8388608","default":"2097152","minimum":"0","type":"integer"}}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"upgrade_opportunities":{"additionalProperties":{"description":"The property name is the cPanel account.","properties":{"bw_limit":{"description":"Upgrade opportunities related to bandwidth limits.","properties":{"this_month":{"allOf":[{"type":"object","description":"Bandwidth usage for this month."},{"$ref":"#/components/schemas/bwSchema"}]},"last_month":{"allOf":[{"type":"object","description":"Bandwidth usage for last month."},{"$ref":"#/components/schemas/bwSchema"}]},"messages":{"type":"array","items":{"example":"This account has used 54% of its bandwidth quota for this month.","type":"string"},"description":"An array of human-readable messages representing the facts listed in the other structured data in the `bw_limit` object."}},"type":"object"},"messages":{"example":["This account has used 54% of its bandwidth quota for this month.","This account has used 94% of its disk quota."],"items":{"type":"string"},"description":"An array of human-readable messages representing the facts listed in the other structured data.","type":"array"},"disk_usage":{"description":"Upgrade opportunities related to disk usage.","type":"object","properties":{"relative_to_fixed_amount":{"allOf":[{"description":"Relative to a preset fixed amount (customizable).","type":"object"},{"$ref":"#/components/schemas/diskSchema"}]},"relative_to_quota":{"allOf":[{"description":"Relative to the account's quota, if applicable.","type":"object"},{"$ref":"#/components/schemas/diskSchema"}]},"messages":{"type":"array","description":"An array of human-readable messages representing the facts listed in the other structured data in the `disk_usage` object.","items":{"example":"This account has used 94% of its disk quota.","type":"string"}}}}}},"description":"The collection of accounts and information about their upgrade opportunities."}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"description":"The method name called.","example":"get_upgrade_opportunities","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}}}}}}}}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"name":"Account Management","description":"Accounts / Account Management"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{"bwSchema":{"$ref":"#/components/schemas/nearReachedBaseSchema"},"nearReachedBaseSchema":{"properties":{"reached":{"example":"1","enum":["0","1"],"description":"Whether the account has reached this resource limit.\n\n* `1` — Reached.\n* `0` — Not reached.","type":"integer"},"fraction":{"type":"number","example":"0.54","description":"A fractional number ranging from 0.00 to 1.00 indicating the fraction of the resource limit that was consumed."},"near":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the account is near this resource limit. Nearness is defined according to `nearness_fraction`.\n\n* `1` — Near.\n* `0` — Not near."}},"type":"object"},"diskSchema":{"allOf":[{"$ref":"#/components/schemas/nearReachedBaseSchema"},{"properties":{"reached":{"type":"integer","nullable":"true","enum":["0","1"]},"threshold_blocks":{"nullable":"true","description":"The block threshold used for the resource limit check.","example":"10485760","type":"integer"},"near":{"type":"integer","enum":["0","1"],"nullable":"true"},"fraction":{"type":"number","nullable":"true"}}}]}}},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.103.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"systemloadavg":{"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / System Information","name":"System Information"}],"paths":{"/systemloadavg":{"get":{"parameters":[],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"one":{"type":"number","description":"The server's load average over the previous minute.","example":"0.17"},"fifteen":{"type":"number","description":"The server's load average over the previous fifteen minutes.","example":"0.19"},"five":{"example":"0.18","description":"The server's load average over the previous five minutes.","type":"number"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"systemloadavg","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.28","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  systemloadavg\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/systemloadavg?api.version=1"}],"tags":["Server Administration","System Information"],"summary":"Return system load average","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Server Administration","tags":["System Information"]}]},"twofactorauth_set_tfa_config":{"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}],"paths":{"/twofactorauth_set_tfa_config":{"get":{"parameters":[{"description":"A generated code for use with 2FA in Base32 format.","schema":{"type":"string","example":"WJ73QJSKZBXCFIPZ"},"name":"secret","in":"query","required":"true"},{"name":"tfa_token","in":"query","required":"true","description":"The time-based one-time password (TOTP) that the authentication app provides.","schema":{"example":"227174","type":"string"}}],"operationId":"twofactorauth_set_tfa_config","description":"This function sets the secret and the authentication code for Two-Factor Authentication (2FA) for the `root` or reseller account. You can generate a random secret and an OTP authentication URL with WHM API 1's `twofactorauth_generate_tfa_configorauth_generate_tfa_config` function.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"success":{"enum":["0","1"],"example":"1","description":"Whether the account successfully enabled 2FA.\n* `1` — Enabled.\n* `0` — **Not** enabled.","type":"integer"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"twofactorauth_set_tfa_config","description":"The method name called."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"54","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_set_tfa_config \\\n  secret='WJ73QJSKZBXCFIPZ' \\\n  tfa_token='227174'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_set_tfa_config?api.version=1&secret=WJ73QJSKZBXCFIPZ&tfa_token=227174"}],"tags":["Authentication","Two-Factor Authentication"],"summary":"Update 2FA authentication secret and code","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"system_needs_reboot":{"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"System Information","description":"Server Administration / System Information"}],"paths":{"/system_needs_reboot":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"system_needs_reboot","description":"The method name called."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"]},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"needs_reboot":{"enum":["0","1"],"example":"1","description":"Whether the system requires a reboot.\n\n* `1` — System requires a reboot.\n* `0` — System does **not** require a reboot.","type":"integer"},"details":{"description":"An object that contains reasons why the system requires a reboot.","properties":{"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"},"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.","type":"object","properties":{"boot_version":{"type":"string","example":"3.10.0-514.10.2.e17.x86_64","description":"The version that the system's kernel updated to."},"running_version":{"description":"The kernel version that the server currently runs.","example":"3.10.0-514.10.2.e17.x86_64","type":"string"}}},"updates":{"type":"object","example":{"glibc":"2.17-157.el7_3.1"},"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."}},"type":"object"}},"type":"object"}}}}},"x-cpanel-available-version":"64","parameters":[],"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","x-cpanel-api-version":"WHM API 1","summary":"Return whether system needs reboot","tags":["Server Administration","System Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  system_needs_reboot\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/system_needs_reboot?api.version=1"}]}}},"x-tagGroups":[{"tags":["System Information"],"name":"Server Administration"}],"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"apply_dmarc":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.123.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/apply_dmarc":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"apply_dmarc"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"type":"object","properties":{"payload":{"type":"array","description":"An array of objects that contains information about the DMARC records applied to domains.","items":{"type":"object","properties":{"status":{"type":"integer","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"},"msg":{"type":"string","example":"[ADD:TXT@_dmarc.example.com:v=DMARC1; p=reject;]","description":"The domain's DMARC record status message."},"domain":{"type":"string","format":"domain","description":"The domain for which the DMARC record was applied.","example":"example.com"}}}}}}}}}}}},"x-cpanel-available-version":"124","parameters":[{"in":"query","name":"domain","required":"false","examples":{"single":{"summary":"To apply a single domain DMARC record","value":"example.com"},"multiple":{"summary":"To apply multiple DMARC records","value":"domain=example-1.com domain=example-2.com domain=example-3.com"}},"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.","schema":{"type":"string"}},{"required":"true","in":"query","name":"policy","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":{"value":"policy=\"v=DMARC1; p=none;\" policy=\"v=DMARC1; p=reject;\" policy=\"v=DMARC1; p=quarantine;\"","summary":"To apply multiple DMARC policies, duplicate the policy arguments."},"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\""}}}],"operationId":"EmailAuth::apply_dmarc","description":"This function applies a DMARC record to the specified domain(s).\n\n**Note:**\n\n You **cannot** modify DMARC records on temporary domains.","x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/apply_dmarc?api.version=1&domain=example.com&policy='v=DMARC1; p=reject;'","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"name":"Mail DNS Settings","description":"Mail / Mail DNS Settings"}]},"remote_mysql_create_profile_via_ssh":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/remote_mysql_create_profile_via_ssh":{"get":{"tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  remote_mysql_create_profile_via_ssh \\\n  name='MyProfileSSH' \\\n  user='SSHuser' \\\n  host='192.168.0.1' \\\n  port='22'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_create_profile_via_ssh?api.version=1&name=MyProfileSSH&user=SSHuser&host=192.168.0.1&port=22"}],"x-cpanel-api-version":"WHM API 1","summary":"Create remote MySQL profile via SSH","operationId":"remote_mysql_create_profile_via_ssh","description":"This function uses SSH to create a profile to access a remote MySQL® server.","parameters":[{"in":"query","name":"name","required":"true","description":"The new profile's name.","schema":{"example":"MyProfileSSH","type":"string"}},{"schema":{"example":"SSHuser","type":"string"},"description":"The SSH username.","required":"true","in":"query","name":"user"},{"required":"false","name":"password","in":"query","schema":{"type":"string","example":"12345luggage"},"description":"The SSH username's password.\n\n**Warning:**\n\n You **must** specify either the `password` or the `sshkey_name` parameter."},{"description":"The name of the SSH key.\n\n**Warning:**\n\n You **must** specify either the `password` or the `sshkey_name` parameter.","schema":{"type":"string","example":"VinzClortho"},"name":"sshkey_name","in":"query","required":"false"},{"name":"sshkey_passphrase","in":"query","required":"false","description":"The SSH key's passphrase.\n\n**Warning:**\n\n This parameter is **required** if the `sshkey_name` value is password-protected.","schema":{"example":"Gozer","type":"string"}},{"description":"The MySQL server's IP address or hostname.","schema":{"oneOf":[{"type":"string","format":"ipv4"},{"format":"hostname","type":"string"}],"example":"192.168.0.1"},"name":"host","in":"query","required":"true"},{"description":"The SSH server's port.","schema":{"minimum":"1","type":"integer","maximum":"65535","example":"22"},"in":"query","name":"port","required":"true"},{"description":"The escalation method to use to authenticate the account.\n\n**Warning:**\n\n This parameter is **required** if the user parameter's value is not `root`.","schema":{"type":"string","example":"su","enum":["sudo","su"]},"name":"root_escalation_method","in":"query","required":"false"},{"in":"query","name":"root_password","required":"false","description":"The MySQL server's root user's password.\n\n**Warning:**\n\n This parameter is **required** if the `root_escalation_method` parameter's value is `su`.","schema":{"type":"string","example":"username"}},{"description":"Whether the remote database profile is a cPanel Cloud deployment.\n\n* `1` — Is cPanel Cloud.\n* `0` — **Not** cPanel Cloud.","schema":{"default":"0","example":"1","type":"integer"},"in":"query","name":"cpcloud","required":"false"}],"x-cpanel-available-version":"11.52","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profile_saved":{"type":"string","description":"The new profile's name.","example":"MyProfileSSH"},"profile_details":{"type":"object","properties":{"cpcloud":{"type":"integer","description":"Whether the remote database profile is a cPanel Cloud deployment.\n\n* `1` — Is cPanel Cloud.\n* `0` — **Not** cPanel Cloud.","default":"0","example":"0","enum":["0","1"]},"mysql_port":{"example":"3306","description":"The MySQL server's port.","maximum":"65535","type":"integer","minimum":"1"},"mysql_pass":{"type":"string","description":"The MySQL server's password.","example":"12345luggage"},"setup_via":{"type":"string","maxLength":"255","example":"Created via SSH","description":"description of the profile data."},"mysql_host":{"oneOf":[{"format":"ipv4","type":"string"},{"format":"hostname","type":"string"}],"description":"The MySQL server's IP address or hostname.","example":"192.168.0.1"},"mysql_user":{"description":"The MySQL server's username.","example":"username","type":"string"}},"description":"An object containing the new profile's data."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","description":"The method name called.","example":"remote_mysql_create_profile_via_ssh"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"name":"Databases","tags":["Remote MySQL Databases"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"description":"The Databases module for WHM API 1.","name":"Databases"},{"name":"Remote MySQL Databases","description":"Databases / Remote MySQL Databases"}]},"unlink_user_authn_provider":{"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Authentication / Authentication Providers","name":"Authentication Providers"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Authentication","tags":["Authentication Providers"]}],"paths":{"/unlink_user_authn_provider":{"get":{"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"unlink_user_authn_provider","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."}}}}}}},"description":"HTTP Request was successful."}},"operationId":"unlink_user_authn_provider","description":"This function unlinks a cPanel account from an external authentication identity provider.","parameters":[{"description":"The account's username.","schema":{"type":"string","example":"example"},"in":"query","name":"username","required":"true"},{"schema":{"type":"string","example":"cpanelid"},"description":"The system's internal key for the identity provider.","required":"true","in":"query","name":"provider_id"},{"name":"subject_unique_identifier","in":"query","required":"true","description":"The unique identifier for the user at the identity provider.","schema":{"example":"123456789012345678901","type":"string"}}],"summary":"Unregister cPanel account from authentication provider","x-cpanel-api-version":"WHM API 1","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"},{"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","label":"URL","lang":"HTTP"}],"tags":["Authentication","Authentication Providers"]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"generate_cpanel_plugin":{"paths":{"/generate_cpanel_plugin":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"description":"This function is for internal use only."}},"description":"This function is for internal use only.","operationId":"generate_cpanel_plugin","x-cpanel-internal-only":"true","x-cpanel-api-version":"WHM API 1","summary":"Generate a cPanel Plugin","tags":["Styles"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  generate_cpanel_plugin\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/generate_cpanel_plugin?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Accounts","tags":["Styles"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Styles","description":"The Styles and Themes module for WHM API 1."}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"get_maximum_users":{"tags":[{"description":"Accounts / Account Creation","name":"Account Creation"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Accounts","tags":["Account Creation"]}],"paths":{"/get_maximum_users":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return maximum accounts for license","tags":["Account Creation"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_maximum_users\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_maximum_users?api.version=1"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"users":{"type":"integer","minimum":"0","description":"The maximum number of cPanel accounts that the server's license allows.\n* `0` - Unlimited","example":"100"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"type":"string","description":"The method name called.","example":"get_maximum_users"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"78","parameters":[],"operationId":"get_maximum_users","description":"This function returns the maximum number of cPanel accounts that the server's license allows."}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"88","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"saveacllist":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"openapi":"3.0.2","x-tagGroups":[{"name":"Resellers","tags":["Account Permissions"]}],"paths":{"/saveacllist":{"get":{"description":"This function creates or modifies an Access Control List (ACL).\n\n**Note:**\n\n  For each `acl-*` parameter, a value of `1` adds that privilege to the ACL list and a value of `0` 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":"saveacllist","parameters":[{"schema":{"example":"my_acl_list","type":"string"},"description":"The ACL to assign to the reseller.\n\n**Note:**\n\n To modify an existing ACL, set this value to that ACL's name.","required":"true","in":"query","name":"acllist"},{"description":"Whether to allow the reseller to edit hosting plans (packages).","schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"in":"query","name":"acl-edit-pkg","required":"false"},{"description":"Whether to allow the reseller to add and remove hosting plans (packages).","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"in":"query","name":"acl-add-pkg","required":"false"},{"name":"acl-list-pkgs","in":"query","required":"false","description":"Whether to allow the reseller to view existing hosting plans (packages).","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"}},{"name":"acl-mailcheck","in":"query","required":"false","description":"Whether to allow the reseller to troubleshoot mail delivery.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"}},{"in":"query","name":"acl-generate-email-config","required":"false","description":"Whether to allow the reseller to generate a mobile configuration profile for an email account.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"}},{"required":"false","in":"query","name":"acl-show-bandwidth","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to allow the reseller to view account bandwidth usage."},{"required":"false","in":"query","name":"acl-list-accts","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"description":"Whether to allow the reseller to view the list of accounts."},{"required":"false","name":"acl-acct-summary","in":"query","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"description":"Whether to allow the reseller to view an account summary."},{"description":"Whether to allow the reseller to use DNS clusters.","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"name":"acl-clustering","in":"query","required":"false"},{"description":"Whether to allow the reseller to modify the server's news.","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"in":"query","name":"acl-news","required":"false"},{"required":"false","in":"query","name":"acl-thirdparty","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to manage third-party services."},{"description":"Whether to allow the reseller to remove DNS zones.","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"in":"query","name":"acl-kill-dns","required":"false"},{"description":"Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"in":"query","name":"acl-cpanel-api","required":"false"},{"description":"Whether to allow the reseller to edit DNS zones.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"name":"acl-edit-dns","in":"query","required":"false"},{"schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to allow the reseller to park DNS zones.","required":"false","name":"acl-park-dns","in":"query"},{"required":"false","in":"query","name":"acl-create-dns","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"description":"Whether to allow the reseller to add DNS zones."},{"in":"query","name":"acl-manage-api-tokens","required":"false","description":"Whether to allow the reseller to manage API tokens.\n\n**Notes:**\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.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]}},{"required":"false","in":"query","name":"acl-manage-oidc","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"description":"Whether to allow the reseller to manage external authentication for their accounts."},{"description":"Whether to allow the reseller to manage DNS records.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"name":"acl-manage-dns-records","in":"query","required":"false"},{"description":"Whether to allow the reseller to manage their server's cPanel styles.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"name":"acl-manage-styles","in":"query","required":"false"},{"required":"false","name":"acl-ns-config","in":"query","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"description":"Whether to allow the reseller to manage nameservers."},{"description":"Whether to allow the reseller to perform SSL site management.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"in":"query","name":"acl-ssl","required":"false"},{"description":"Whether to allow the reseller to view their server's SSL information.","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"name":"acl-ssl-info","in":"query","required":"false"},{"in":"query","name":"acl-mysql-info","required":"false","description":"Whether to allow the reseller to retrieve MySQL® database and user data.","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"}},{"description":"Whether to allow the reseller to create accounts.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"in":"query","name":"acl-create-acct","required":"false"},{"required":"false","name":"acl-suspend-acct","in":"query","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to allow the reseller to suspend or unsuspend accounts."},{"name":"acl-basic-system-info","in":"query","required":"false","description":"Whether to allow the reseller to retrieve basic system information.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"}},{"description":"Whether to allow the reseller to access basic cPanel & WHM options.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"in":"query","name":"acl-basic-whm-functions","required":"false"},{"schema":{"enum":["0","1"],"example":"1","default":"0","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.","required":"false","in":"query","name":"acl-passwd"},{"required":"false","name":"acl-ssl-buy","in":"query","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to purchase SSL certificates."},{"schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"description":"Whether to allow the reseller to manage how their server and its services connect to other servers and services.","required":"false","name":"acl-cpanel-integration","in":"query"},{"required":"false","in":"query","name":"acl-cors-proxy-get","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"description":"Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests."},{"description":"Whether to allow the reseller to upgrade or downgrade accounts.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"in":"query","name":"acl-upgrade-account","required":"false"},{"schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to generate SSL certificates.","required":"false","name":"acl-ssl-gencrt","in":"query"},{"schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"description":"Whether to allow the reseller to create a temporary user session for a specified service.\n\n**Notes:**\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.","required":"false","in":"query","name":"acl-create-user-session"},{"in":"query","name":"acl-edit-mx","required":"false","description":"Whether to allow the reseller to edit MX entries.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"}},{"required":"false","in":"query","name":"acl-digest-auth","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"description":"Whether to allow the reseller to manage Digest Authentication support."},{"schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to allow the reseller to terminate accounts.","required":"false","in":"query","name":"acl-kill-acct"},{"in":"query","name":"acl-viewglobalpackages","required":"false","description":"Whether to allow the reseller to use all global packages. For more information, read our [reseller packages](https://go.cpanel.net/GuidetoResellerAccounts#which-packages-can-resellers-view-and-assign) documentation.","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"}},{"schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to create accounts with shell access.","required":"false","in":"query","name":"acl-allow-shell"},{"description":"Whether to allow the reseller to create packages with shell access.","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"in":"query","name":"acl-add-pkg-shell","required":"false"},{"schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to allow the reseller to create packages with addon domains.","required":"false","in":"query","name":"acl-allow-addoncreate"},{"schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"description":"Whether to allow the reseller to create packages with custom email quotas.","required":"false","name":"acl-allow-emaillimits-pkgs","in":"query"},{"description":"Whether to allow the reseller to create packages with parked domains (aliases).","schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"in":"query","name":"acl-allow-parkedcreate","required":"false"},{"description":"Whether to allow the reseller to create packages with unlimited disk space.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"},"name":"acl-allow-unlimited-disk-pkgs","in":"query","required":"false"},{"schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"description":"Whether to allow the reseller to create packages with unlimited features.","required":"false","name":"acl-allow-unlimited-pkgs","in":"query"},{"schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"},"description":"Whether to allow the reseller to create packages with unlimited bandwidth.","required":"false","name":"acl-allow-unlimited-bw-pkgs","in":"query"},{"schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"description":"Whether to allow the reseller to create packages with a dedicated IP address.","required":"false","in":"query","name":"acl-add-pkg-ip"},{"name":"acl-locale-edit","in":"query","required":"false","description":"Whether to allow the reseller to create and modify locales on the server.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"}},{"name":"acl-resftp","in":"query","required":"false","description":"Whether to allow the reseller to resync FTP passwords.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"}},{"in":"query","name":"acl-restart","required":"false","description":"Whether to allow the reseller to restart services.","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"}},{"name":"acl-status","in":"query","required":"false","description":"Whether to allow the reseller to view the server's status.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"}},{"required":"false","name":"acl-stats","in":"query","schema":{"default":"0","enum":["0","1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to view server information."},{"required":"false","name":"acl-quota","in":"query","schema":{"default":"0","enum":["0","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, this privilege allows resellers to circumvent package limits for disk space."},{"description":"Whether to allow the reseller to enable demo mode for accounts.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"in":"query","name":"acl-demo-setup","required":"false"},{"description":"Whether to allow the reseller to edit accounts.","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"},"in":"query","name":"acl-edit-account","required":"false"},{"schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"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.","required":"false","name":"acl-limit-bandwidth","in":"query"},{"required":"false","name":"acl-rearrange-accts","in":"query","schema":{"enum":["0","1"],"example":"1","default":"0","type":"integer"},"description":"Whether to allow the reseller to rearrange accounts."},{"required":"false","name":"acl-track-email","in":"query","schema":{"example":"1","enum":["0","1"],"default":"0","type":"integer"},"description":"Whether to allow the reseller to view reports about email message delivery attempts from their account."},{"schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"},"description":"Whether to grant the reseller all privileges.\n\n**Warning:**\n\n A value of `1` grants root-level privileges to the reseller.","required":"false","name":"acl-all","in":"query"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"type":"string","example":"saveacllist","description":"The method name called."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"type":"string","example":"ACL List my_acl_list saved.","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  saveacllist \\\n  acllist='my_acl_list'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/saveacllist?api.version=1&acllist=my_acl_list","label":"URL","lang":"HTTP"}],"tags":["Resellers","Account Permissions"],"summary":"Create or update privilege list and settings","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"description":"Resellers / Account Permissions","name":"Account Permissions"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}]},"nginxmanager_reset_users_cache_config":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"name":"NGINX Manager","description":"The NGINX Manager module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["NGINX Manager"],"name":"NGINX Manager"}],"paths":{"/nginxmanager_reset_users_cache_config":{"get":{"tags":["NGINX Manager"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  nginxmanager_reset_users_cache_config\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_reset_users_cache_config?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Restore NGINX configuration to default values.","parameters":[{"explode":"true","schema":{"type":"array","default":[],"items":{"format":"username","type":"string"},"format":"username","example":["unclebob","auntsue"]},"required":"false","in":"query","name":"user","description":"A list of users to reset to the NGINX system default.\n\n**Note:**\n\nIf you do not pass this parameter, this function resets the configuration to the default for all users on the system.","style":"form"}],"description":"This function resets a user to the NGINX system default.","operationId":"nginxmanager_reset_users_cache_config","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"nginxmanager_reset_users_cache_config","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11"}}}},"get_udp4_sockets":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Connections","description":"Server Administration / Connections"}],"paths":{"/get_udp4_sockets":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"get_udp4_sockets","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"payload":{"type":"array","items":{"properties":{"dport":{"minimum":"1","type":"integer","description":"The source port that the Linux kernel reports for the socket.","example":"443"},"rqueue":{"example":"0","description":"The number of bytes in the socket's read buffer.","format":"bytes","type":"integer","minimum":"1"},"uid":{"minimum":"1","type":"integer","example":"25","description":"The socket's user ID (UID)."},"sport":{"minimum":"1","type":"integer","description":"The source port number.","example":"53"},"wqueue":{"description":"The number of bytes that the system is waiting to send.","format":"bytes","example":"45","minimum":"1","type":"integer"},"inode":{"type":"integer","minimum":"1","description":"The inode number the Linux kernel assigned to the socket.","example":"27171"},"dst":{"type":"string","example":"10.0.0.2","format":"ipv4","description":"The destination IPv4 address."},"state":{"description":"The socket's current state, in the Linux kernel's numeric format.","example":"10","type":"integer","minimum":"1"},"src":{"type":"string","example":"10.0.0.1","format":"ipv4","description":"The source IPv4 address."}},"type":"object"},"description":"An array of objects that contains the status of the system's UDP IPv4 sockets."}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"80","parameters":[],"description":"This function returns data about the system's user datagram protocol (UDP) IPv4 sockets.","operationId":"get_udp4_sockets","x-cpanel-api-version":"WHM API 1","summary":"Return UDP IPv4 sockets data","tags":["Server Administration","Connections"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_udp4_sockets\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_udp4_sockets?api.version=1"}]}}},"x-tagGroups":[{"tags":["Connections"],"name":"Server Administration"}]},"set_tier":{"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"paths":{"/set_tier":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update cPanel & WHM release tier","tags":["Updates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  set_tier \\\n  tier='current'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_tier?api.version=1&tier=current"}],"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"tier":{"type":"string","example":"current","enum":["edge","current","release","stable","lts"],"description":"The server's new support tier."}},"type":"object"},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"set_tier","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Update tier successfully changed to current"}}}}}}}}},"description":"This function sets a cPanel & WHM server to a specified [support tier](https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/).","operationId":"set_tier","parameters":[{"required":"true","in":"query","name":"tier","schema":{"type":"string","enum":["edge","current","release","stable","lts"],"example":"current"},"description":"The support tier to use."}]}}},"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"is_sni_supported":{"openapi":"3.0.2","info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"paths":{"/is_sni_supported":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return server SNI support status","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  is_sni_supported\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/is_sni_supported?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.40","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"sni":{"description":"Whether the server supports SNI.\n- `1` — SNI supported.\n- `0` — SNI **not** supported.","example":"1","enum":["0","1"],"type":"integer"}}},"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"example":"is_sni_supported","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"example":"OK","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.","type":"string"}}}},"type":"object"}}}}},"operationId":"is_sni_supported","description":"This function checks whether the server supports SNI (Server Name Indication).\n\n**Note:**\n\n  * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.\n  * Functions that disable Mail SNI fail and make no changes.","parameters":[]}}},"x-tagGroups":[{"tags":["Mail Server Settings"],"name":"Mail"}]},"disable_failing_authentication_providers":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Authentication / External Authentication","name":"External Authentication"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Authentication","tags":["External Authentication"]}],"paths":{"/disable_failing_authentication_providers":{"get":{"operationId":"disable_failing_authentication_providers","description":"This function disables any enabled identity provider modules that fail to load.","parameters":[],"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"example":"disable_failing_authentication_providers","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"payload":{"description":"An array of objects containing information about the external authentication identity provider module failures.","items":{"properties":{"failures_to_disable":{"items":{"type":"object","properties":{"failure":{"type":"string","example":"An informative failure message.","description":"A description of the failure to disable the identity provider module for that module."},"service_name":{"type":"string","example":"whostmgrd","description":"A cPanel service for which the system failed to disable the external authentication identity provider."}}},"description":"An array of objects containing the cPanel services for which the system fails to disable the module.","type":"array"},"provider_failure":{"type":"string","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","description":"A description of the failure."},"provider_name":{"example":"facebook","description":"The external authentication identity provider to disable.","type":"string"},"disabled_services":{"items":{"type":"string"},"description":"An array of the cPanel services for which the external authentication identity provider was previously disabled.","example":["cpaneld","webmaild"],"type":"array"},"provider_namespace":{"example":"Cpanel::Security::Authn::Provider::Facebook","description":"The external authentication identity provider module's namespace.","type":"string"}},"type":"object"},"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  disable_failing_authentication_providers\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_failing_authentication_providers?api.version=1"}],"tags":["Authentication","External Authentication"],"summary":"Disable identity provider modules that fail to load","x-cpanel-api-version":"WHM API 1"}}}},"unassign_account_enhancement":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/unassign_account_enhancement":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"unassign_account_enhancement","type":"string"},"reason":{"example":"OK","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.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.98","parameters":[{"in":"query","name":"account","required":"true","description":"The username of the account.","schema":{"example":"username","format":"username","type":"string"}},{"schema":{"type":"string","example":"enhancement 5000"},"description":"The name of the account enhancement.","required":"true","name":"name","in":"query"}],"description":"This function removes an Account Enhancement from a cPanel account.","operationId":"unassign_account_enhancement","summary":"Unassign Account Enhancement","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  unassign_account_enhancement \\\n  account='username' \\\n  name='enhancement 5000'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unassign_account_enhancement?api.version=1&account=username&name=enhancement%205000"}],"tags":["Account Enhancements"]}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Enhancements"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Account Enhancement module for WHM.","name":"Account Enhancements"}]},"list_cparchive_files":{"paths":{"/list_cparchive_files":{"get":{"x-cpanel-available-version":"11.42","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"list_cparchive_files","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"quickrestore_files":{"items":{"properties":{"file":{"type":"string","description":"The backup file's name in one of the formats listed above.","example":"cpmove-username1.tar.gz"},"user":{"type":"string","example":"username","description":"The backup file's account."},"path":{"type":"string","example":"/home","description":"The backup file's directory in one of the locations listed above."}},"type":"object"},"description":"An array of objects that contains information about each `cparchive` file.","type":"array"}}}},"type":"object"}}}}},"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":[],"x-cpanel-api-version":"WHM API 1","summary":"Return cparchive files list","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_cparchive_files\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_cparchive_files?api.version=1"}]}}},"x-tagGroups":[{"name":"Backups","tags":["Backup or Restore"]}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"twofactorauth_policy_status":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"}],"paths":{"/twofactorauth_policy_status":{"get":{"x-cpanel-available-version":"54","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"twofactorauth_policy_status","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"is_enabled":{"description":"Whether the 2FA security policy is enabled.\n- `1` — Enabled.\n- `0` — **Not** enabled.","enum":["0","1"],"example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"twofactorauth_policy_status","description":"This function displays the Two-Factor Authentication (2FA) policy status on the server.","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return 2FA policy status","tags":["Authentication","Two-Factor Authentication"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  twofactorauth_policy_status\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_policy_status?api.version=1","lang":"HTTP","label":"URL"}]}}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}]},"get_market_providers_products":{"tags":[{"description":"The Market module for WHM API 1.","name":"Market"},{"description":"cPanel Market / Product Management","name":"Product Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Product Management"],"name":"cPanel Market"}],"paths":{"/get_market_providers_products":{"get":{"x-cpanel-available-version":"56","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/MarketItemType"},"description":"A list of the products in the cPanel Market.\n\n**Note:**\n\nAdditional returns that correspond to each product may appear.","example":[{"provider_name":"cPStore","x_price_per_domain_minimum":"108","price_unit":"USD","description":"An extended-validated (EV) SSL certificate signed by COMODO.","product_id":"155","x_max_http_redirects":"0","price":null,"x_payment_trigger":"checkout","base_name":"","product_category":"N/A","max_users":null,"provider_display_name":"cPanel Store","x_certificate_term":["1","year"],"product_group":"ssl_certificate","x_warn_after":"604800","license_term":"0","billing_type":"one-time","x_validation_type":"ev","product":"Comodo EV Certificate","x_supports_dns_dcv":"1","maximum_server_price":null,"x_price_per_domain_maximum":"1080","icon_mime_type":"image/svg+xml","x_ssl_per_domain_pricing":"1","x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"label":"Department Name","is_optional":"1","name":"organizationalUnitName"},{"pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","name":"duns_number","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","is_optional":"1"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"name":"postalCode","label":"Postal Code"},{"label":"Country Code","type":"country_code","name":"countryName"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"name":"rep_surname","label":"Representative’s Surname (Last Name)"},{"name":"rep_email_address","type":"email","label":"Representative’s Email Address"},{"is_optional":"1","label":"Representative’s Telephone Number","description":"This should be one of the organization’s publicly-listed telephone numbers.","type":"tel","name":"rep_telephone"},{"label":"Business Category","description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","type":"choose_one","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]]},{"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","is_optional":"1","name":"joi_locality_name"},{"is_optional":"1","label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"name":"joi_country_name","type":"country_code","label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))"},{"is_optional":"1","label":"Date of Incorporation","type":"date","name":"date_of_incorporation"},{"is_optional":"1","label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"minimum_server_price":null,"x_price_per_domain":"108","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","display_name":"Comodo EV SSL Certificate","requires_ip":"0"},{"product_id":"261","price":null,"x_max_http_redirects":"0","provider_name":"cPStore","x_price_per_domain_minimum":"216","description":"A 2-year extended-validated (EV) SSL certificate signed by Comodo.","price_unit":"USD","product_group":"ssl_certificate","license_term":"0","x_validation_type":"ev","billing_type":"one-time","x_warn_after":"604800","base_name":"","product_category":"N/A","max_users":null,"x_payment_trigger":"checkout","provider_display_name":"cPanel Store","x_certificate_term":["2","year"],"x_ssl_per_domain_pricing":"1","x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"name":"organizationalUnitName","is_optional":"1","label":"Department Name"},{"name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","is_optional":"1"},{"label":"Street Address","name":"streetAddress"},{"name":"localityName","label":"City"},{"name":"stateOrProvinceName","label":"State or Province"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","type":"country_code","name":"countryName"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"name":"rep_surname","label":"Representative’s Surname (Last Name)"},{"label":"Representative’s Email Address","type":"email","name":"rep_email_address"},{"name":"rep_telephone","type":"tel","description":"This should be one of the organization’s publicly-listed telephone numbers.","label":"Representative’s Telephone Number","is_optional":"1"},{"type":"choose_one","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"name":"business_category","label":"Business Category","description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options."},{"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","is_optional":"1","name":"joi_locality_name"},{"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","is_optional":"1","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","type":"country_code","name":"joi_country_name"},{"label":"Date of Incorporation","is_optional":"1","name":"date_of_incorporation","type":"date"},{"label":"Assumed Name (DBA (Doing Business As))","is_optional":"1","name":"assumed_name"}],"maximum_server_price":null,"x_supports_dns_dcv":"1","product":"Comodo EV Certificate","x_price_per_domain_maximum":"2160","icon_mime_type":"image/svg+xml","display_name":"2-Year Comodo EV SSL Certificate","requires_ip":"0","minimum_server_price":null,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","x_price_per_domain":"216"},{"x_ssl_per_domain_pricing":"1","x_identity_verification":[{"name":"organizationName","label":"Organization Name"},{"name":"organizationalUnitName","label":"Department Name","is_optional":"1"},{"is_optional":"1","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","name":"duns_number"},{"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"},{"type":"email","name":"rep_email_address","label":"Representative’s Email Address"},{"type":"tel","name":"rep_telephone","is_optional":"1","label":"Representative’s Telephone Number","description":"This should be one of the organization’s publicly-listed telephone numbers."}],"maximum_server_price":null,"x_supports_dns_dcv":"1","product":"Comodo OV Certificate","x_price_per_domain_maximum":"360","icon_mime_type":"image/svg+xml","display_name":"Comodo OV SSL Certificate","x_wildcard_parent_domain_free":"1","requires_ip":"0","minimum_server_price":null,"x_price_per_domain":"36","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","x_price_per_wildcard_domain":"150.00","product_id":"217","price":null,"x_max_http_redirects":"0","provider_name":"cPStore","x_price_per_domain_minimum":"36","description":"An organization-validated (OV) SSL certificate signed by COMODO.","x_price_per_wildcard_domain_minimum":"150.00","price_unit":"USD","x_price_per_wildcard_domain_maximum":"1500.00","product_group":"ssl_certificate","license_term":"0","billing_type":"one-time","x_validation_type":"ov","x_warn_after":"604800","product_category":"N/A","base_name":"","max_users":null,"x_payment_trigger":"checkout","provider_display_name":"cPanel Store","x_certificate_term":["1","year"]},{"x_certificate_term":["2","year"],"provider_display_name":"cPanel Store","x_payment_trigger":"checkout","max_users":null,"product_category":"N/A","base_name":"","x_warn_after":"604800","billing_type":"one-time","x_validation_type":"ov","license_term":"0","product_group":"ssl_certificate","x_price_per_wildcard_domain_maximum":"3000.00","price_unit":"USD","x_price_per_wildcard_domain_minimum":"300.00","description":"A 2-year organization-validated (OV) SSL certificate signed by Comodo.","provider_name":"cPStore","x_price_per_domain_minimum":"72","x_max_http_redirects":"0","price":null,"x_price_per_wildcard_domain":"300.00","product_id":"253","x_price_per_domain":"72","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","minimum_server_price":null,"requires_ip":"0","x_wildcard_parent_domain_free":"1","display_name":"2-Year Comodo OV SSL Certificate","icon_mime_type":"image/svg+xml","x_price_per_domain_maximum":"720","product":"Comodo OV Certificate","x_supports_dns_dcv":"1","maximum_server_price":null,"x_identity_verification":[{"name":"organizationName","label":"Organization Name"},{"name":"organizationalUnitName","is_optional":"1","label":"Department Name"},{"name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","is_optional":"1","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"},{"name":"streetAddress","label":"Street Address"},{"name":"localityName","label":"City"},{"label":"State or Province","name":"stateOrProvinceName"},{"name":"postalCode","label":"Postal Code"},{"name":"countryName","type":"country_code","label":"Country Code"},{"name":"rep_forename","label":"Representative’s Given (First) Name"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","type":"email","name":"rep_email_address"},{"name":"rep_telephone","type":"tel","label":"Representative’s Telephone Number","description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":"1"}],"x_ssl_per_domain_pricing":"1"},{"x_price_per_domain_maximum":"30","icon_mime_type":"image/svg+xml","maximum_server_price":null,"x_supports_dns_dcv":"1","product":"cPanel DV Certificate","x_identity_verification":null,"x_ssl_per_domain_pricing":"1","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","x_price_per_domain":"9","minimum_server_price":null,"requires_ip":"0","display_name":"cPanel DV SSL Certificate","x_wildcard_parent_domain_free":"1","description":"A domain-validated (DV) SSL certificate signed by cPanel.","x_price_per_wildcard_domain_minimum":"75.00","price_unit":"USD","x_price_per_domain_minimum":"3","provider_name":"cPStore","price":null,"x_max_http_redirects":"0","product_id":"159","x_price_per_wildcard_domain":"75.00","provider_display_name":"cPanel Store","x_certificate_term":["1","year"],"product_category":"N/A","base_name":"","max_users":null,"x_payment_trigger":"issuance","license_term":"0","x_validation_type":"dv","billing_type":"one-time","x_warn_after":"604800","x_price_per_wildcard_domain_maximum":"750.00","product_group":"ssl_certificate"},{"x_identity_verification":null,"x_ssl_per_domain_pricing":"1","icon_mime_type":"image/svg+xml","x_price_per_domain_maximum":"60","maximum_server_price":null,"product":"cPanel DV Certificate","x_supports_dns_dcv":"1","requires_ip":"0","display_name":"2-Year cPanel DV SSL Certificate","x_wildcard_parent_domain_free":"1","x_price_per_domain":"18","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","minimum_server_price":null,"price":null,"x_max_http_redirects":"0","product_id":"225","x_price_per_wildcard_domain":"150.00","x_price_per_wildcard_domain_minimum":"150.00","description":"A 2-year domain-validated (DV) SSL certificate signed by cPanel.","price_unit":"USD","x_price_per_domain_minimum":"6","provider_name":"cPStore","billing_type":"one-time","x_validation_type":"dv","license_term":"0","x_warn_after":"604800","product_group":"ssl_certificate","x_price_per_wildcard_domain_maximum":"1500.00","x_certificate_term":["2","year"],"provider_display_name":"cPanel Store","max_users":null,"product_category":"N/A","base_name":"","x_payment_trigger":"issuance"},{"minimum_server_price":null,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","x_price_per_domain":"30","display_name":"cPanel OV SSL Certificate","x_wildcard_parent_domain_free":"1","requires_ip":"0","maximum_server_price":null,"product":"cPanel OV Certificate","x_supports_dns_dcv":"1","icon_mime_type":"image/svg+xml","x_price_per_domain_maximum":"300","x_ssl_per_domain_pricing":"1","x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"name":"organizationalUnitName","label":"Department Name","is_optional":"1"},{"name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":"1"},{"name":"streetAddress","label":"Street Address"},{"label":"City","name":"localityName"},{"name":"stateOrProvinceName","label":"State or Province"},{"name":"postalCode","label":"Postal Code"},{"label":"Country Code","type":"country_code","name":"countryName"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"type":"email","name":"rep_email_address","label":"Representative’s Email Address"},{"is_optional":"1","label":"Representative’s Telephone Number","description":"This should be one of the organization’s publicly-listed telephone numbers.","type":"tel","name":"rep_telephone"}],"max_users":null,"base_name":"","product_category":"N/A","x_payment_trigger":"checkout","x_certificate_term":["1","year"],"provider_display_name":"cPanel Store","product_group":"ssl_certificate","x_price_per_wildcard_domain_maximum":"990.00","x_validation_type":"ov","billing_type":"one-time","license_term":"0","x_warn_after":"604800","x_price_per_domain_minimum":"30","provider_name":"cPStore","x_price_per_wildcard_domain_minimum":"99.00","description":"An organization-validated (OV) SSL certificate signed by cPanel.","price_unit":"USD","x_price_per_wildcard_domain":"99.00","product_id":"213","price":null,"x_max_http_redirects":"0"},{"product":"cPanel OV Certificate","x_supports_dns_dcv":"1","maximum_server_price":null,"icon_mime_type":"image/svg+xml","x_price_per_domain_maximum":"600","x_ssl_per_domain_pricing":"1","x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"label":"Department Name","is_optional":"1","name":"organizationalUnitName"},{"pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","name":"duns_number","is_optional":"1","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"},{"name":"streetAddress","label":"Street Address"},{"name":"localityName","label":"City"},{"name":"stateOrProvinceName","label":"State or Province"},{"name":"postalCode","label":"Postal Code"},{"type":"country_code","name":"countryName","label":"Country Code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"type":"email","name":"rep_email_address","label":"Representative’s Email Address"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","label":"Representative’s Telephone Number","is_optional":"1","name":"rep_telephone","type":"tel"}],"minimum_server_price":null,"x_price_per_domain":"60","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","x_wildcard_parent_domain_free":"1","display_name":"2-Year cPanel OV SSL Certificate","requires_ip":"0","provider_name":"cPStore","x_price_per_domain_minimum":"60","price_unit":"USD","x_price_per_wildcard_domain_minimum":"198.00","description":"A 2-year organization-validated (OV) SSL certificate signed by cPanel.","product_id":"233","x_price_per_wildcard_domain":"198.00","x_max_http_redirects":"0","price":null,"x_payment_trigger":"checkout","max_users":null,"base_name":"","product_category":"N/A","x_certificate_term":["2","year"],"provider_display_name":"cPanel Store","product_group":"ssl_certificate","x_price_per_wildcard_domain_maximum":"1980.00","x_warn_after":"604800","x_validation_type":"ov","billing_type":"one-time","license_term":"0"},{"x_price_per_domain_minimum":"12","provider_name":"cPStore","price_unit":"USD","x_price_per_wildcard_domain_minimum":"99.00","description":"A domain-validated (DV) SSL certificate signed by COMODO.","x_price_per_wildcard_domain":"99.00","product_id":"151","x_max_http_redirects":"0","price":null,"x_payment_trigger":"issuance","max_users":null,"base_name":"","product_category":"N/A","x_certificate_term":["1","year"],"provider_display_name":"cPanel Store","product_group":"ssl_certificate","x_price_per_wildcard_domain_maximum":"990.00","x_warn_after":"604800","billing_type":"one-time","x_validation_type":"dv","license_term":"0","product":"Comodo DV Certificate","x_supports_dns_dcv":"1","maximum_server_price":null,"icon_mime_type":"image/svg+xml","x_price_per_domain_maximum":"120","x_ssl_per_domain_pricing":"1","x_identity_verification":null,"minimum_server_price":null,"x_price_per_domain":"12","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","x_wildcard_parent_domain_free":"1","display_name":"Comodo DV SSL Certificate","requires_ip":"0"},{"display_name":"2-Year Comodo DV SSL Certificate","x_wildcard_parent_domain_free":"1","requires_ip":"0","minimum_server_price":null,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","x_price_per_domain":"24","x_ssl_per_domain_pricing":"1","x_identity_verification":null,"maximum_server_price":null,"product":"Comodo DV Certificate","x_supports_dns_dcv":"1","x_price_per_domain_maximum":"240","icon_mime_type":"image/svg+xml","x_price_per_wildcard_domain_maximum":"1980.00","product_group":"ssl_certificate","license_term":"0","x_validation_type":"dv","billing_type":"one-time","x_warn_after":"604800","product_category":"N/A","base_name":"","max_users":null,"x_payment_trigger":"issuance","provider_display_name":"cPanel Store","x_certificate_term":["2","year"],"x_price_per_wildcard_domain":"198.00","product_id":"245","price":null,"x_max_http_redirects":"0","provider_name":"cPStore","x_price_per_domain_minimum":"24","description":"A 2-year domain-validated (DV) SSL certificate signed by Comodo.","x_price_per_wildcard_domain_minimum":"198.00","price_unit":"USD"},{"x_max_http_redirects":"0","price":null,"product_id":"209","price_unit":"USD","description":"An extended-validated (EV) SSL certificate signed by cPanel.","x_price_per_domain_minimum":"60","provider_name":"cPStore","x_warn_after":"604800","license_term":"0","x_validation_type":"ev","billing_type":"one-time","product_group":"ssl_certificate","provider_display_name":"cPanel Store","x_certificate_term":["1","year"],"x_payment_trigger":"checkout","product_category":"N/A","base_name":"","max_users":null,"x_identity_verification":[{"name":"organizationName","label":"Organization Name"},{"label":"Department Name","is_optional":"1","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","is_optional":"1","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","name":"duns_number"},{"name":"streetAddress","label":"Street Address"},{"name":"localityName","label":"City"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","type":"country_code","name":"countryName"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"name":"rep_surname","label":"Representative’s Surname (Last Name)"},{"name":"rep_email_address","type":"email","label":"Representative’s Email Address"},{"is_optional":"1","description":"This should be one of the organization’s publicly-listed telephone numbers.","label":"Representative’s Telephone Number","type":"tel","name":"rep_telephone"},{"name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one","description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category"},{"name":"joi_locality_name","label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","is_optional":"1"},{"name":"joi_state_or_province_name","is_optional":"1","label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"type":"date","name":"date_of_incorporation","is_optional":"1","label":"Date of Incorporation"},{"name":"assumed_name","label":"Assumed Name (DBA (Doing Business As))","is_optional":"1"}],"x_ssl_per_domain_pricing":"1","x_price_per_domain_maximum":"600","icon_mime_type":"image/svg+xml","product":"cPanel EV Certificate","x_supports_dns_dcv":"1","maximum_server_price":null,"requires_ip":"0","display_name":"cPanel EV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","x_price_per_domain":"60","minimum_server_price":null},{"x_warn_after":"604800","license_term":"0","billing_type":"one-time","x_validation_type":"ev","product_group":"ssl_certificate","provider_display_name":"cPanel Store","x_certificate_term":["2","year"],"x_payment_trigger":"checkout","product_category":"N/A","base_name":"","max_users":null,"x_max_http_redirects":"0","price":null,"product_id":"241","price_unit":"USD","description":"A 2-year extended-validated (EV) SSL certificate signed by cPanel.","x_price_per_domain_minimum":"120","provider_name":"cPStore","requires_ip":"0","display_name":"2-Year cPanel EV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","x_price_per_domain":"120","minimum_server_price":null,"x_identity_verification":[{"name":"organizationName","label":"Organization Name"},{"is_optional":"1","label":"Department Name","name":"organizationalUnitName"},{"pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$","name":"duns_number","is_optional":"1","label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"},{"name":"streetAddress","label":"Street Address"},{"name":"localityName","label":"City"},{"label":"State or Province","name":"stateOrProvinceName"},{"name":"postalCode","label":"Postal Code"},{"name":"countryName","type":"country_code","label":"Country Code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"name":"rep_surname","label":"Representative’s Surname (Last Name)"},{"type":"email","name":"rep_email_address","label":"Representative’s Email Address"},{"is_optional":"1","description":"This should be one of the organization’s publicly-listed telephone numbers.","label":"Representative’s Telephone Number","type":"tel","name":"rep_telephone"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","type":"choose_one","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"name":"business_category"},{"name":"joi_locality_name","is_optional":"1","label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))"},{"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","is_optional":"1","name":"joi_state_or_province_name"},{"type":"country_code","name":"joi_country_name","label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))"},{"label":"Date of Incorporation","is_optional":"1","name":"date_of_incorporation","type":"date"},{"is_optional":"1","label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_ssl_per_domain_pricing":"1","x_price_per_domain_maximum":"1200","icon_mime_type":"image/svg+xml","product":"cPanel EV Certificate","x_supports_dns_dcv":"1","maximum_server_price":null}]}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"get_market_providers_products","description":"The method name called."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"reason":{"type":"string","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":"object"}}}}},"description":"This function lists products available in the server's cPanel Market.","operationId":"Market-get_market_providers_products","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return Market providers products","tags":["Market","Product Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_market_providers_products\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_products?api.version=1","lang":"HTTP","label":"URL"}]}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{"MarketItem":{"description":"A product available from one of the cPanel Market providers.","type":"object","properties":{"requires_ip":{"enum":["1","0"],"example":"0","default":"0","description":"Whether product require an IP address.\n* `1` - The product requires an IP address.\n* `0` - The product does **NOT** require an IP address.","type":"string"},"billing_type":{"type":"string","description":"The type of billing used with the product.\n\n* `none` - The product is free.\n* `one-time` - Use of the product requires a one-time payment.\n* `monthly` - Use of the product requires a monthly subscription payment.\n* `yearly` - Use of the product requires a yearly subscription payment.","enum":["none","one-time","monthly","yearly"]},"product_group":{"description":"The product's group.","example":"ssl_certificate","type":"string"},"display_name":{"description":"The product's display name.","example":"EV Certificate by cPanel.","type":"string"},"provider_display_name":{"type":"string","description":"The cPanel Market provider's display name.","example":"cPanel Store"},"icon":{"type":"string","format":"base64 image","description":"The icon to display in the product list."},"minimum_server_price":{"nullable":"true","format":"currency","description":"The minimum price that the system will allow for the product.","example":"3","type":"string"},"max_users":{"description":"The maximum number of users the system will allow for the product.","nullable":"true","type":"integer"},"product_category":{"type":"string","example":"N/A"},"price":{"example":"6","format":"currency","description":"The product's price.\n* `null` - The item does not possess a static price.","nullable":"true","minimum":"1","type":"string"},"product_id":{"type":"string","example":"12345","description":"The product's ID."},"price_unit":{"description":"The currency code of the product's price.","format":"ISO-4217","example":"USD","type":"string"},"icon_mime_type":{"description":"The icon's image format.","format":"MIME","example":"image/svg+xml","type":"string"},"description":{"type":"string","example":"An Extended Validation (EV) SSL certificate signed by cPanel.","description":"A description of the product."},"product":{"type":"string","description":"The human-readable product name. Use this in displays to the user.","example":"Comodo EV Certificate"},"provider_name":{"example":"cPStore","description":"The cPanel Market provider's name.","type":"string"},"maximum_server_price":{"example":"20","description":"The maximum price that the system will allow for the product.","format":"currency","nullable":"true","type":"string"}}},"SSLCertificateMarketItem":{"allOf":[{"$ref":"#/components/schemas/MarketItem"},{"properties":{"x_payment_trigger":{"description":"Whether the provider charges immediately or when they issue the SSL certificate.\n\n* `checkout` - Collect payment and finalize immediately after checkout. Any failures to issue the certificate **must** prompt a separate refund.\n* `issuance` - Collect payment when the provider issues the certificate to the user.","example":"issuance","enum":["checkout","issuance"],"type":"string"},"x_price_per_domain":{"type":"string","description":"The product's price per domain.","format":"currency","example":"3"},"x_certificate_term":{"description":"An array indicating the length and unit of time that the product secures for.","items":{"type":"string"},"example":["1","year"],"type":"array"},"x_wildcard_parent_domain_free":{"example":"1","enum":["1","0"],"description":"Whether the provider includes the price of the parent domain in the price of a wildcard certificate.\n\nFor example, a wildcard certificate for `*.example.com` possesses the `example.com` parent domain.\n\n* `1` - Yes, the parent domain is included.\n* `0` - No, the parent domain costs extra.","type":"integer"},"x_price_per_wildcard_domain_maximum":{"format":"currency","description":"The maximum price per wildcard domain.","example":"990.00","type":"string"},"x_validation_type":{"description":"The type of validation that the product creates.\n\n* `dv` - Domain Validation\n* `ev` - Extended Validation\n* `ov` - Organization Validation","enum":["dv","ev","ov"],"example":"dv"},"x_warn_after":{"minimum":"1","type":"integer","description":"A length of time, in seconds, after which the cPanel interface\n  warns the user that a problem may exist with the order.\nThe warning will suggest that they should contact\n  the cPanel Market provider's support contact.","example":"14400"},"x_price_per_domain_minimum":{"description":"The minimum price per domain.","format":"currency","example":"3.00","type":"string"},"x_supports_dns_dcv":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether this product supports DNS-based DCV.\n* `1` - This product supports DNS-based DCV.\n* `0` - This product does *not* support DNS-based DVC."},"x_price_per_wildcard_domain_minimum":{"type":"string","description":"The minimum price per wildcard domain.","format":"currency","example":"99.00"},"x_price_per_domain_maximum":{"type":"string","example":"30.00","description":"The maximum price per domain.","format":"currency"},"x_ssl_per_domain_pricing":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether the provider uses per-domain pricing for this certificate.\n* `1` - The provider uses per-domain pricing.\n* `0` - The provider does *not* use per-domain pricing."},"x_price_per_wildcard_domain":{"example":"99.00","format":"currency","description":"The price per domain for a wildcard certificate.","type":"string"},"x_identity_verification":{"type":"array","items":{"type":"object","properties":{"is_optional":{"description":"Whether the value is optional.\n* `1` - Optional.\n* Any object that does **not** contain a `1` value indicates that the SSL certificate provider requires identity verification.","example":"1","enum":["1"],"type":"integer"},"label":{"type":"string","example":"Company Name","description":"A phrase that serves as a label for the value."},"description":{"type":"string","description":"A sentence that provides more information about the SSL provider.","example":"This is a company name"},"type":{"description":"A description of the value.\n* `text` - A general text statement.\n* `email` - An email address.\n* `tel` - A telephone number.\n* `country_code` - A country code ID.\n* `choose_one` - The user must select one of the provided options.\n* A date, in `yyyy-MM-dd` format.","oneOf":[{"example":"choose_one","enum":["test","email","tel","country_code","choose_one"],"type":"string"},{"type":"string","format":"ISO-8601 Date","example":"2020-08-15T00:00:00.000Z"}],"type":"string"},"pattern":{"type":"string","format":"regex","description":"A regular expression pattern that clients should use to verify the relevant value prior to order submission.\n\n**Note:**\n\nThis return only appears if the `type` return contains the `text` value.","example":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},"name":{"description":"The name by which to submit this value.","example":"duns_number","type":"string"},"options":{"type":"array","description":"An array of two member arrays.\n\n**Note:**\n\nThis return **only** appears if the type return contains the `choose_one` value.","example":[["b","Incorporated Business"],["d","Government Entity"]]}}},"description":"An array of objects that define a schema for identity\n  verification information for Organizational Validation (OV)\n  and Extended Validation (EV) certificates.\nOV and EV certificates require identifying information."},"x_max_http_redirects":{"description":"The maximum number of HTTP redirections that the\n  provider allows during a Domain Control Validation (DCV)\n  check of the domain or domains in the certificate.","example":"1","minimum":"0","type":"integer"}},"type":"object"}],"description":"An SSL certificate product available from one of the cPanel Market providers."},"MarketItemType":{"anyOf":[{"$ref":"#/components/schemas/MarketItem"},{"$ref":"#/components/schemas/SSLCertificateMarketItem"}]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."}},"ticket_get_support_agreement":{"x-tagGroups":[{"name":"cPanel Support Tickets","tags":["Ticket Management"]}],"paths":{"/ticket_get_support_agreement":{"get":{"summary":"Import Technical Support Agreement text","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_get_support_agreement?api.version=1"}],"tags":["Support Tickets","Ticket Management"],"x-cpanel-available-version":"60","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","description":"The method name called.","example":"ticket_get_support_agreement"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"create_date":{"type":"integer","description":"The creation or publication Unix timestamp of the Technical Support Agreement's current version.","format":"unix_timestamp","example":"1564790400"},"create_date_human":{"type":"string","description":"The human-readable date at which the current version of the Technical Support Agreement was created or published, in `MM/DD/YY` format.","example":"8/3/19"},"download_url":{"format":"url","description":"The URL at which the end-user may download the support agreement.","example":"https://www.cpanel.net/legal/techagreement_download.cgi","type":"string"},"accepted":{"example":"0","enum":["0","1"],"description":"Whether the user associated with the OAuth token has already accepted this\nversion of the agreement.\n\n* `1` — Accepted.\n* `0` — **Not** accepted.","type":"integer"},"body":{"example":"<p>IMPORTANT: THIS TECHNICAL SUPPORT AGREEMENT ... at the end of AGREEMENT","description":"The full Technical Support Agreement.\n\n**Note:**\n\nThis returned value may contain HTML.","type":"string"},"accepted_date_human":{"nullable":"true","description":"The human-readable date at which the user associated with the OAuth token\naccepted the Technical Support Agreement.\n\n* A human-readable date, in `MM/DD/YY` format.\n* `null` — Never accepted.","example":"8/17/19","type":"string"},"accepted_date":{"nullable":"true","example":"1566000000","format":"unix_timestamp","description":"The [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time)\nat which the user associated with the OAuth token accepted the\nTechnical Support Agreement.\n\n* A valid Unix timestamp.\n* `null` — Never accepted.","type":"integer"},"view_url":{"description":"The URL at which the end-user may view the Technical Support Agreement agreement as a standalone HTML document.","format":"url","example":"http://cpanel.com/technical-support-agreements.html","type":"string"},"version":{"type":"string","description":"The Technical Support Agreement's version.","example":"2019-04.v01.TSUPPORT"},"title":{"type":"string","example":"Technical Support Agreement","description":"The Technical Support Agreement's title."}}}},"type":"object"}}}}},"description":"This function retrieves the WebPros International, LLC Technical Support Agreement text\nand metadata about the user's agreement status from the\n[cPanel Customer Portal](https://tickets.cpanel.net/).\n\n**Note:**\n* This function is **not** available through the command line. You **must** call it\nas a request body.\n* To use this function, you **must** set up a cPanelID token in your current session.\nFor more information, read our\n[cPanelID](https://docs.cpanel.net/knowledge-base/accounts/cpanelid/)\ndocumentation.","operationId":"ticket_get_support_agreement","parameters":[]}}},"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"description":"cPanel Support Tickets / Ticket Management","name":"Ticket Management"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2"},"ticket_create_stub_ticket":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"name":"Ticket Management","description":"cPanel Support Tickets / Ticket Management"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Ticket Management"],"name":"cPanel Support Tickets"}],"paths":{"/ticket_create_stub_ticket":{"get":{"operationId":"ticket_create_stub_ticket","description":"This function creates a stub ticket. The system uses the stub ticket\nto create a cPanel support ticket.\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call\nit as a request body.","parameters":[],"x-cpanel-available-version":"60","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"secure_id":{"example":"rofh411bv8","description":"The support ticket's secure ID token.","type":"string"},"ticket_id":{"type":"integer","minimum":"1","example":"7648492","description":"The support ticket number that other functions can look up."}}},"metadata":{"properties":{"command":{"type":"string","example":"ticket_create_stub_ticket","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_create_stub_ticket?api.version=1"}],"tags":["Support Tickets","Ticket Management"],"summary":"Create initial Support ticket request","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1"}}}},"get_countries_with_known_ip_ranges":{"paths":{"/get_countries_with_known_ip_ranges":{"get":{"tags":["cPHulk","Reporting"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_countries_with_known_ip_ranges\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","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","summary":"Return login security country codes","parameters":[],"description":"This function lists the country codes available for whitelist and blacklist functions.","operationId":"get_countries_with_known_ip_ranges","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","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":{"type":"object","properties":{"name":{"type":"string","description":"The country's name.","example":"United States"},"code":{"example":"US","format":"ISO-3166-1 (alpha-2)","description":"A valid [ISO 3166-1 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).","pattern":"^[A-Z]{2}$","type":"string"}}},"type":"array"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"get_countries_with_known_ip_ranges","description":"The method name called.","type":"string"}}}}}}}}},"x-cpanel-available-version":"70"}}},"x-tagGroups":[{"tags":["Reporting"],"name":"Login Security (cPHulk)"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"cPHulk","description":"The cPHulk module for WHM API 1."},{"description":"Login Security (cPHulk) / Reporting","name":"Reporting"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"modsec_make_config_active":{"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Server Settings","name":"Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Server Settings"]}],"paths":{"/modsec_make_config_active":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"modsec_make_config_active"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{}}}}}}}},"x-cpanel-available-version":"11.46","parameters":[{"in":"query","name":"config","required":"true","description":"The ModSecurity configuration file's path and filename, relative to the `/usr/local/apache/conf/` diretory.","schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}}],"operationId":"modsec_make_config_active","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.","summary":"Add ModSecurity configuration file include","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_make_config_active \\\n  config='modsec_vendor_configs/example.conf'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_make_config_active?api.version=1&config=modsec_vendor_configs%2fexample.conf","lang":"HTTP","label":"URL"}],"tags":["ModSecurity","Server Settings"]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999"}},"cluster_member_has_trust_with":{"paths":{"/cluster_member_has_trust_with":{"get":{"parameters":[{"description":"The nameserver's IP address.","schema":{"format":"ipv4","example":"192.0.2.0","type":"string"},"name":"host","in":"query","required":"true"},{"required":"false","in":"query","name":"althost","schema":{"default":"8.8.8.8","format":"ipv4","example":"192.0.3.0","type":"string"},"description":"The nameserver's alternate IP address. This is useful, for example, if your DNS cluster exists in a NAT-configured network."}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"has_trust":{"enum":["0","1"],"example":"1","description":"Whether the nameserver can send information to other cluster members.\n* `1` — Can send information.\n* `0` — Can't send information.","type":"integer"}}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"command":{"example":"cluster_member_has_trust_with","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}}}},"x-cpanel-available-version":"84","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cluster_member_has_trust_with \\\n  host='192.0.2.0'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cluster_member_has_trust_with?api.version=1&host=192.0.2.0","lang":"HTTP","label":"URL"}],"tags":["DNS","DNS Zones"],"summary":"Return whether DNS cluster server can share records","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"tags":["DNS Zones"],"name":"DNS"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Zones","name":"DNS Zones"}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_autossl_problems_for_domain":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}],"paths":{"/get_autossl_problems_for_domain":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return domain DCV issues","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_autossl_problems_for_domain \\\n  domain='example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_problems_for_domain?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"68","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"problems_by_domain":{"type":"array","description":"An array of objects that contains DCV problems for a domain.","items":{"description":"An object containing information about a DCV problem for a domain.","type":"object","properties":{"problem":{"type":"string","description":"The problem the domain encountered during DCV.","example":"The domain does not resolve to any IPv4 addresses on the internet."},"domain":{"description":"The domain queried for problems.","format":"domain","example":"example.tld","type":"string"},"log":{"example":"2017-08-19T13:41:04.000Z","description":"The name of the directory containing the log files for this problem. This directory is located under `/var/cpanel/logs/autossl/`.","format":"ISO-8601 Date Time","type":"string"},"time":{"description":"The time that the problem occurred.","format":"ISO-8601 Date Time","example":"2017-08-19T13:41:04.000Z","type":"string"}}}}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"get_autossl_problems_for_domain"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"get_autossl_problems_for_domain","description":"This function returns a list of objects that contains the latest Domain Control Validation (DCV) problems for a specific domain.","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","format":"domain","example":"example.com"},"description":"The domain for which to poll the DCV status."}]}}}},"lookupnsip":{"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / Resolvers","name":"Resolvers"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Resolvers"],"name":"DNS"}],"paths":{"/lookupnsip":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  lookupnsip \\\n  host='ns1.example.com'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/lookupnsip?api.version=1&host=ns1.example.com","label":"URL","lang":"HTTP"}],"tags":["DNS","Resolvers"],"summary":"Return nameserver's IP address","x-cpanel-api-version":"WHM API 1","description":"This function retrieves a nameserver's IP address.","operationId":"lookupnsip","parameters":[{"schema":{"format":"domain","example":"ns1.example.com","type":"string"},"description":"The nameserver's hostname.","required":"true","in":"query","name":"host"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"lookupnsip","description":"The method name called.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"ip":{"example":"192.168.0.20","format":"ipv4","description":"The nameserver's IP address.","type":"string"}},"type":"object"}},"type":"object"}}}}}}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"get_service_config":{"paths":{"/get_service_config":{"get":{"tags":["Server Administration","Services"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_service_config \\\n  service='dovecot'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_service_config?api.version=1&service=dovecot","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return service configuration settings","operationId":"get_service_config","description":"This function returns a service's configuration settings.","parameters":[{"schema":{"example":"dovecot","enum":["dovecot"],"type":"string"},"description":"The service's name.\n\n* `dovecot` — The Dovecot service.\n\n**Note:**\n\nFor a fresh install, the data returned for the Dovecot\nservice will only contain the list of protocols. It will\nnot be until the mailserver configuration is saved that\nthe return data for Dovecot will look like what is shown\nin the example.","required":"true","name":"service","in":"query"}],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"additionalProperties":{"description":"A configuration key's setting.\n\n**Note:**\n\nThe key name is the return's name.","anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]},"type":"object","description":"A list of the configuration key's settings.","example":{"expire_spam":"0","mail_process_size":"512","protocol_pop3":{"mail_max_userip_connections":"3"},"lmtp_process_limit":"500","auth_allow_cleartext":"yes","auth_cache_negative_ttl":"3600","lmtp_user_concurrency_limit":"4","mdbox_rotate_size":"10M","config_vsz_limit":"2048","lmtp_process_min_avail":"0","compress_messages":"0","include_trash_in_quota":"0","auth_cache_ttl":"3600","protocols":"imap pop3","auth_cache_size":"1M","login_process_per_connection":"no","expire_trash":"0","incoming_reached_quota":"bounce","ssl_cipher_list":"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","hulk_auth_passwd":"FAMONex4Bn9Hv1BO","protocol_imap":{"map_idle_notify_interval":"24","mail_max_userip_connections":"20"},"login_max_processes_count":"50","ssl_min_protocol":"TLSv1.2","login_processes_count":"2","auth_policy_hash_nonce":"91057590","login_process_size":"128","mdbox_rotate_interval":"0","ipv6":"on"}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"get_service_config"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Server Administration","tags":["Services"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Services","description":"Server Administration / Services"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"accountsummary":{"x-tagGroups":[{"tags":["Account Management"],"name":"Accounts"}],"paths":{"/accountsummary":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  accountsummary \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/accountsummary?api.version=1&user=username","label":"URL","lang":"HTTP"}],"tags":["Accounts","Account Management"],"summary":"Return cPanel account summary","x-cpanel-api-version":"WHM API 1","operationId":"accountsummary","description":"This function retrieves a summary of a user's account.\n\n**Note:**\n\nYou must use either the user or domain parameters.","parameters":[{"schema":{"example":"username","type":"string"},"description":"The account's username.","required":"false","in":"query","name":"user"},{"description":"The account's main domain.","schema":{"type":"string","example":"example.com"},"in":"query","name":"domain","required":"false"},{"in":"query","name":"searchtype","required":"false","description":"The type of search to perform.","schema":{"type":"string","example":"domain"}},{"schema":{"example":"exact","type":"string"},"description":"The search method to use.","required":"false","name":"searchmethod","in":"query"},{"required":"false","name":"search","in":"query","schema":{"example":"example.com","type":"string"},"description":"The search term."}],"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"accountsummary","description":"The method name called."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` Success\n* `0` Failed: Check the reason field for more details."}}},"data":{"properties":{"acct":{"type":"array","description":"An array of objects of account data.","items":{"properties":{"unix_startdate":{"type":"integer","description":"The account creation date. The account creation date and time, in Unix time format.","format":"unix_timestamp","example":"1369256589"},"maxsub":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"example":"unlimited","description":"The account's maximum number of subdomains.\n* `unlimited`\n* `*unknown*` The account cannot use any subdomains.\n* An integer that represents a number of subdomains."},"startdate":{"example":"13 May 22 16:03","format":"YY-Mon-DD-HH-MM","description":"The account creation date. The date in YY-Mon-DD HH-mm human-readable format, where:- YY represents the year.\n* `Mon` represents the month.\n* `DD` represents the date.\n* `HH` represents the hour.\n* `mm` represents the minute.","type":"string"},"diskused":{"type":"string","example":"14M","format":"mebibyte-short","description":"The account's current disk space usage. An integer that represents an amount of disk space, in mebibyte (MiB). For example, 14M represents 14 MiB of disk space."},"is_locked":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the account is currently locked.\n* `1` Locked.\n* `0` Not locked."},"disklimit":{"oneOf":[{"type":"string","enum":["unlimited"]},{"type":"integer","minimum":"0"}],"example":"unlimited","description":"The account's disk space quota.\n* `unlimited`\n* A maximum amount of disk space, in mebibyte (MiB)."},"ipv6":{"items":{"type":"string","format":"ipv6","example":"0101:ca75:0101:ca75:0101:ca75:0101:ca77"},"description":"The account's main domain's IPv6 addresses.","type":"array"},"shell":{"description":"The account's shell. A shell location on the server.","format":"shell","example":"/bin/bash","type":"string"},"min_defer_fail_to_trigger_protection":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"example":"5","description":"The minimum number of failed or deferred messages that the account can send before\noutgoing mail is subject to rate-limiting.\n* `unlimited`\n* An integer that represents a number of failed or deferred messages."},"max_defer_fail_percentage":{"description":"The percentage of failed or deferred email messages that the account\ncan send per hour before outgoing mail is rate-limited.\n* `unlimited`\n* An integer that represents a percentage of messages.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}]},"user":{"type":"string","format":"username","description":"The account username. A cPanel account or reseller username on the server.","example":"username"},"suspendtime":{"type":"string","example":null,"description":"The time of suspension.\n* `null` The account is not currently suspended.\n* The time at which the account became suspended.","nullable":"true"},"domain":{"example":"example.com","format":"fqdn","description":"The account's main domain. A valid domain name on the account.","type":"string"},"maxlst":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of mailing lists.\n* `unlimited`\n* An integer that represents a number of mailing lists.","example":"unlimited"},"ip":{"example":"192.168.0.128","format":"ipv4","description":"The account's main domain's IP address.","type":"string"},"backup":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether backups are enabled.\n* `1` Enabled.\n* `0` Disabled."},"outgoing_mail_hold":{"example":"0","enum":["0","1"],"description":"Whether to retain outgoing mail in the mail queue for the account's users.\n* `1` Suspend and force failure of outgoing email.\n* `0` Unsuspend outgoing email.","type":"integer"},"partition":{"type":"string","example":"home","description":"The partition that contains the account's home directory. The name of a partition on the server."},"theme":{"example":"jupiter","format":"theme","description":"The account's cPanel interface theme.\n* Any valid theme on the server.","type":"string"},"inodeslimit":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The limit on the number of files that the account owns.\n* `unlimited`\n* A maximum amount of files as an integer.","example":"unlimited"},"maxftp":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of FTP accounts.\n* `unlimited`\n* An integer that represents a number of FTP accounts.","example":"unlimited"},"maxsql":{"example":"unlimited","description":"The account's maximum number of SQL databases.\n* `unlimited`\n* An integer that represents a number of SQL databases.","oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}]},"child_nodes":{"description":"An array that contains the the workload and alias values for each of the child nodes.","items":{"properties":{"workload":{"type":"string","description":"The workload delegated to the child node","enum":["Mail"],"example":"Mail"},"alias":{"example":"nodealias","description":"The alias of the child node","type":"string"}}},"type":"array"},"uid":{"description":"The account's user ID on the system.","type":"integer"},"legacy_backup":{"type":"integer","description":"Whether legacy backups are enabled.\n* `1` Enabled.\n* `0` Disabled.","enum":["0","1"],"example":"0"},"maxparked":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of parked domains (aliases).\n* `unlimited`\n* `*unknown*` The account cannot use any parked domains.\n* An integer that represents a number of parked domains.","example":"unlimited"},"is_temporary_domain":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the main domain is a temporary domain.\n* `1` - The account's main domain is a temporary domain.\n* `0` - The account's main domain is not a temporary domain.\n\n**Note:**\n\nFor more information about temporary domains, read our [Temporary Domains](https://go.cpanel.net/cp-temporary-domain) documentation."},"max_emailacct_quota":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}],"example":"unlimited","description":"The maximum size that the cPanel account can define when it creates an email account.\n* `unlimited`\n* A positive integer that represents the allowable maximum size of an email account, in mebibyte (MiB)."},"suspendreason":{"type":"string","description":"The reason for account suspension, if one was provided.\n* `null` The account is not currently suspended.\n* A blank value, if the suspender did not provide a reason.\n* A message that explains the suspension.","example":"not suspended","nullable":"true"},"owner":{"type":"string","format":"username","description":"The account's owner.\n* root\n* A reseller account's username.","example":"root"},"maxaddons":{"example":"unlimited","description":"The account's maximum number of addon domains.\n* `unlimited`\n* `*unknown*`  The account cannot use any addon domains.\n* An integer that represents a number of addon domains.","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}]},"plan":{"format":"plan","description":"The account's hosting package. The name of a package on the server.","example":"packagename","type":"string"},"maxpop":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"example":"unlimited","description":"The account's maximum number of email addresses.\n* `unlimited`\n* An integer that represents a number of email accounts."},"inodesused":{"example":"1","description":"The number of files that the account owns.","type":"integer","minimum":"0"},"temporary":{"type":"integer","description":"Whether the Customer Support Ticket process created this user for temporary access to the system.\n* `1` - Temporary user.\n* `0` - Regular user.","example":"0","enum":["0","1"]},"email":{"type":"string","description":"The account's contact email address. A valid email address.","format":"email","example":"username@example.com"},"max_email_per_hour":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"example":"unlimited","description":"The maximum number of emails that the account can send in one hour.\n* `unlimited`\n* An integer that represents a number of sent emails."},"outgoing_mail_suspended":{"type":"integer","description":"Whether to suspend outgoing email from the account's users and force failure of any of their mail currently in the mail queue.\n* `1` - Suspend and force failure of outgoing email.\n* `0` - Unsuspend outgoing email.\n\n**Note:**\n\nIf mail for a cPanel user's account is suspended, the system will reject their email before the system puts it in the mail server queue.","example":"0","enum":["0","1"]},"suspended":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether the account is currently suspended.\n* `1`  Suspended.\n* `0`  Not suspended."},"mailbox_format":{"example":"maildir","enum":["maildir","mbox"],"description":"The storage format that the account's email mailboxes use.\n* `maildir` The account's mail is stored in `maildir` format.\n* `mbox` The account's mail is stored in `mbox` format.","format":"mailbox_format","type":"string"}},"type":"object"}}},"type":"object"}}}}}}}}}},"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"description":"Accounts / Account Management","name":"Account Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"88","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"delete_rpm_version":{"tags":[{"name":"RPM","description":"The RPM module for WHM API 1."},{"description":"System Package Management / Package Manager Settings","name":"Package Manager Settings"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"System Package Management","tags":["Package Manager Settings"]}],"paths":{"/delete_rpm_version":{"get":{"summary":"Remove rpm.versions system configuration","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_rpm_version \\\n  section='rpm_groups' \\\n  key='3rdparty' \\\n  value='cpanel-pcre'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_rpm_version?api.version=1&section=rpm_groups&key=3rdparty&value=cpanel-pcre","lang":"HTTP","label":"URL"}],"tags":["RPM","Package Manager Settings"],"x-cpanel-available-version":"11.32","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"status":{"type":"integer","description":"Whether the function was successful.\n\n* `1` — Success.\n* `0` — Failure.","example":"1","enum":["0","1"]}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"delete_rpm_version","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"delete_rpm_version","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.","parameters":[{"schema":{"example":"rpm_groups","type":"string"},"description":"The RPM's section within the `rpm.versions` file.","required":"true","in":"query","name":"section"},{"in":"query","name":"key","required":"true","description":"The [RPM's target](https://docs.cpanel.net/knowledge-base/rpm-versions/rpm-targets/).","schema":{"type":"string","example":"3rdparty"}},{"schema":{"type":"string","example":"cpanel-pcre"},"description":"The RPM name.","required":"true","name":"value","in":"query"}]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."}},"listaccts":{"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"paths":{"/listaccts":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel accounts","tags":["Accounts","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  listaccts\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/listaccts?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"acct":{"type":"array","description":"An array of objects containing account data.","items":{"type":"object","properties":{"is_locked":{"enum":["0","1"],"example":"0","description":"Whether the account is currently locked.\n* `1` - The account is locked.\n* `0` - The account is **not** locked.","type":"integer"},"startdate":{"example":"13 May 22 16:03","description":"The account creation date, in `YY Mon DD HH:mm` format.","type":"string"},"diskused":{"type":"string","description":"The account's current disk space usage, in megabytes (MB), appended with `M`.\n\nFor example, `14M` represents 14 megabytes of current disk space usage.","example":"14M"},"maxsub":{"description":"The account's maximum number of subdomains.\n* `unlimited` — The account can create unlimited subdomains.\n* `*unknown*` - The account cannot use subdomains.\n* An integer that represents a number of subdomains.","oneOf":[{"enum":["unlimited","*unknown*"],"type":"string"},{"minimum":"0","type":"integer"}]},"unix_startdate":{"example":"1369256589","format":"unix_timestamp","description":"The account creation date.","type":"integer"},"shell":{"example":"/bin/bash","description":"The absolute path of the account's shell location.","type":"string"},"ipv6":{"type":"array","description":"The IPv6 address of the account's main domain.","items":{"format":"ipv6","example":"0101:ca75:0101:ca75:0101:ca75:0101:ca77","type":"string"}},"disklimit":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}],"description":"The account's disk space quota.\n* `unlimited` — The account has unlimited disk space quota.\n* A maximum amount of disk space, in megabytes (MB)."},"suspendtime":{"type":"integer","nullable":"true","description":"The time of suspension.\n* `null` - The account is not currently suspended.\n* The time at which the account became suspended.","format":"unix_timestamp","example":"1594040856"},"user":{"type":"string","example":"username","description":"The account username.","format":"username"},"has_backup":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether a backup of the account exists.\n* `1` - A backup of the account exists.\n* `0` - A backup of the account does **not** exist."},"max_defer_fail_percentage":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"description":"The [percentage of failed or deferred email\nmessages](https://go.cpanel.net/howtopreventspam)\nthat the account can send per hour before outgoing\nmail is rate-limited.\n* `unlimited` — The account can send unlimited emails per hour.\n* An integer that represents a precentage of messages."},"min_defer_fail_to_trigger_protection":{"description":"The [minimum number of failed or deferred messages](https://go.cpanel.net/howtopreventspam) that the\naccount can send before outgoing mail is subject to rate-limiting.\n* `unlimited` — The account can send unlimited emails.\n* An integer that represents a number of failed or deferred messages.","oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}]},"child_nodes":{"type":"array","items":{"properties":{"workload":{"type":"string","description":"The workload delegated to the child node","enum":["Mail"],"example":"Mail"},"alias":{"type":"string","example":"nodealias","description":"The alias of the child node"}}},"description":"An array that contains the the workload and alias values for each of the child nodes."},"uid":{"type":"integer","minimum":"0","example":"1001","description":"The account's user ID on the system."},"partition":{"example":"home","description":"The partition that contains the account's home directory.","type":"string"},"theme":{"type":"string","description":"The account's cPanel interface theme.","example":"jupiter"},"inodeslimit":{"description":"The limit on the number of files that the account owns.\n* `unlimited` — The account can own an unlimited number files.\n* A positive integer.","oneOf":[{"type":"string","enum":["unlimited"]},{"type":"integer","minimum":"0"}]},"maxsql":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of each available type of SQL database.\n\nFor example, if you set this value to `5` and the system administrator allows MySQL® and PostgreSQL®\ndatabases, users can create up to five MySQL databases and up to five PostgreSQL databases.\n\n* `unlimited` — The account can create unlimited SQL databases.\n* An integer that represents a number of SQL databases."},"maxftp":{"oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of FTP accounts.\n* `unlimited` — The account can create unlimited FTP accounts.\n* An integer that represents a number of FTP accounts."},"outgoing_mail_hold":{"example":"1","enum":["1","0"],"description":"Whether to retain outgoing mail in the mail queue for the account's users.\n* `1` - Hold outgoing email in the mail queue.\n* `0` - Do **not** hold outgoingemail in the mail queue.","type":"integer"},"ip":{"type":"string","description":"The IPv4 address of the account's main domain.","format":"ipv4","example":"192.168.0.128"},"backup":{"description":"Whether backups are enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":["0","1"],"example":"0","type":"integer"},"standalone_feature_name":{"description":"The name of the standalone feature associated with the account's package, if any.\n* An empty string if the package has no standalone features.\n* The feature's name if a standalone feature exists.","example":"AI App Builder","type":"string"},"maxlst":{"oneOf":[{"type":"string","enum":["unlimited"]},{"type":"integer","minimum":"0"}],"description":"The account's maximum number of mailing lists.\n* `unlimited` — The account can create unlimited mailing lists.\n* An integer that represents a number of mailing lists."},"domain":{"description":"The account's main domain.","format":"domain","example":"example.com","type":"string"},"plan":{"type":"string","description":"The account's hosting package.","example":"packagename"},"maxaddons":{"oneOf":[{"enum":["unlimited","*unknown*"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of addon domains.\n* `unlimited` — The account can create unlimited addon domains.\n* `*unknown*` — The account cannot create addon domains.\n* An integer that represents a number of addon domains."},"owner":{"description":"The reseller account username or `root` user that owns the account.","example":"root","type":"string"},"suspendreason":{"oneOf":[{"type":"string","description":"If the account is **not** suspended, `suspendreason` will return `not suspended`.","enum":["not suspended"]},{"type":"string","nullable":"true","description":"If the account is suspended, `suspendreason` will return either:\n* A blank value, if the suspender did not provide a reason.\n* A message that explains the suspension.","example":"suspended for non-payment"}],"description":"The reason for account suspension, if one was provided."},"maxparked":{"oneOf":[{"enum":["unlimited","*unknown*"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The account's maximum number of parked domains (aliases).\n* `unlimited` — The account can create unlimited parked domains.\n* `*unknown*` — The account cannot use parked domains.\n* An integer that represents a number of parked domains."},"max_emailacct_quota":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The maximum size, in megabytes (MB), that the account\ncan define when it creates an email account.\n\n* `unlimited` — The account can set unlimited quotas.\n* A positive integer that represents the allowable maximum\nsize of an email account, in megabytes (MB)."},"is_temporary_domain":{"type":"integer","enum":["0","1"],"example":"0","description":"Whether the main domain is a temporary domain.\n* `1` - The account's main domain is a temporary domain.\n* `0` - The account's main domain is not a temporary domain.\n\n**Note:**\n\nFor more information about temporary domains, read our [Temporary Domains](https://go.cpanel.net/cp-temporary-domain) documentation."},"legacy_backup":{"type":"integer","example":"0","enum":["0","1"],"description":"Whether legacy backups are enabled.\n* `1` - Enabled.\n* `0` - Disabled."},"inodesused":{"description":"The number of files that the account owns.","example":"1","type":"integer","minimum":"0"},"maxpop":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}],"description":"The account's maximum number of email addresses.\n* `unlimited` — The account can create unlimited email addresses.\n* An integer that represents a number of email accounts."},"email":{"type":"string","description":"The account's contact email address.","format":"email","example":"username@example.com"},"temporary":{"description":"Whether the Customer Support Ticket process created this user for temporary access to the system.\n* `1` - Temporary user.\n* `0` - Regular user.","enum":["0","1"],"example":"0","type":"integer"},"mailbox_format":{"enum":["mdbox","maildir"],"example":"mdbox","description":"The type of mailbox the account uses.\n\n* `mdbox`\n* `maildir`","type":"string"},"suspended":{"type":"integer","description":"Whether the account is currently suspended.\n* `1` - Suspended.\n* `0` - **Not** suspended.","example":"0","enum":["0","1"]},"outgoing_mail_suspended":{"enum":["0","1"],"example":"0","description":"Whether to suspend outgoing email from the account's users and force failure of any of their mail currently in the mail queue.\n* `1` - Suspend and forcefailure of outgoing email.\n* `0` - Do **not** suspend and forcefailure of outgoing email.\n\n**Note:**\n\nIf mail for a cPanel user's account is suspended, the system will reject their email before the system puts it in the mail server queue.","type":"integer"},"standalone_feature":{"description":"The unique ID of the standalone feature associated with the account's package, if any.\n* An empty string if the package has no standalone features.","example":"standalone-nova","type":"string"},"max_email_per_hour":{"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}],"description":"The [maximum number of emails](https://go.cpanel.net/howtopreventspam)\nthat the account can send in one hour.\n* `unlimited` — The account can send unlimited emails per hour.\n* An integer that represents a number of sent emails."}}}}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"type":"string","description":"The method name called.","example":"listaccts"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"operationId":"listaccts","description":"This function lists the accounts on the server.","parameters":[{"description":"The account information to query. If you do not specify a value\nfor both the `searchtype` and `search` parameters, the function returns all\nof the server's accounts.\n* `domain` - Match domains against the `search` regular expression.\n* `owner` - Match the WHM user who owns the account against the `search` regular expression.\n* `user` - Match usernames against the `search` regular expression.\n* `ip` - Match IP addresses against the `search` regular expression.\n* `package` - Match hosting plans (packages) against the `search` regular expression.","schema":{"enum":["domain","owner","user","ip","package"],"example":"domain","type":"string"},"name":"searchtype","in":"query","required":"false"},{"in":"query","name":"search","required":"false","description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) that filters the results.\n\n**Note:**\n * The system matches the PCRE against the `searchtype` parameter's specified type.\n * If you do not specify a value for both the `searchtype` and `search` parameters,\n   the function returns all of the server's accounts.","schema":{"type":"string","example":"username"}},{"required":"false","name":"searchmethod","in":"query","schema":{"example":"exact","enum":["exact","regex"],"type":"string"},"description":"The function's search method.\n* `exact` - The matched value and the `search` value **must** be identical.\n* `regex` - The matched value must contain the `search` value."},{"description":"The returns to include in the output for each account.\n\nIf you do not specify a value, the function's output includes all of its returns.","schema":{"example":"domain,diskused","type":"string"},"in":"query","name":"want","required":"false"}]}}},"tags":[{"description":"The Accounts module for WHM API 1.","name":"Accounts"},{"name":"Account Management","description":"Accounts / Account Management"}],"servers":[{"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."}},"description":"A server running WHM."}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"expunge_mailbox_messages":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Mail","tags":["cPanel Account Mail Management"]}],"paths":{"/expunge_mailbox_messages":{"get":{"tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  expunge_mailbox_messages \\\n  account='user@example.com' \\\n  mailbox='INBOX' \\\n  query='savedbefore 52w'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/expunge_mailbox_messages?api.version=1&account=user%40example.com&mailbox=INBOX&query=savedbefore%2052w","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Remove email account messages by Dovecot query","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.","schema":{"type":"string","example":"user@example.com","format":"email"},"in":"query","name":"account","required":"true"},{"name":"mailbox","in":"query","required":"true","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.","schema":{"example":"INBOX","type":"string"}},{"schema":{"example":"savedbefore 52w","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.","required":"true","in":"query","name":"query"}],"x-cpanel-available-version":"58","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"expunge_mailbox_messages","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}}}}}},"install_service_ssl_certificate":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}],"paths":{"/install_service_ssl_certificate":{"get":{"tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  install_service_ssl_certificate \\\n  service='cpanel' \\\n  crt='-----BEGIN CERTIFICATE-----\nMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxjZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7GRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+FLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G\n-----END CERTIFICATE-----' \\\n  key='-----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-----'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/install_service_ssl_certificate?api.version=1&service=cpanel&crt=-----BEGIN%20CERTIFICATE-----%0aMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM%2feNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV%2fCo9%2fWwhOCvV%2fBm9aTzueZrbYB%2f9uW31LOpjs%2b0s1QNGHv6PTvH8HZFW%2f7Z9M3gSwUxfOOOQHEiiHRWfb%2fUqcTZZxjZhfY%2fIN6%2fSOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9%2b1YnI7GRqs3%2bGdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0%2bFQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds%2bXDTycHc2bsSH%2bzDkWIw58%2bJ26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV%2bbCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1%2bZwaF7xZ%2bFLMTcEl8SXM%2blkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb%2fKRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf%2fXIoFeV5Zk%2brHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS%2bfU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G%0a-----END%20CERTIFICATE-----&key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aMIIEpQIBAAKCAQEA4FIdZcIKVK5%2bPtdzVm4CN45BXG5wX7KZ1%2fdP84MGIwtwxkkX%0ahBqw7BawbHlexYXuarSnrHA8hm6RRxv%2ffRy%2bzOeg7y8v5CWG52m91GK7qSLxpruY%0agCJGJEK8fj6spbbLjxNd5XAmDwT80uMsq%2f3E9rGmg%2fELY9X9vn5WlErRfi2Qjsiq%0ax7AYUvcIkBHPOlRWzZgx2KjMjBU2U0w2RCUjgKgww%2f6xx2ccnTvn7HGvVjQMkh%2b1%0aUYCdGvT8fR2qJBKHZ5Cjdfc9N304qZCqYMhcrHX2gJqc%2b9zLtLk7PoEYXu17l6nU%0aO3C%2fIdzBXYWu%2bUoMzpZ5tc5jKRA3%2bI7ggKjJlwIDAQABAoIBAQDR4GI648qQolXh%0a6%2biws%2bqFGibTGU0wbET%2bSBjYx%2f0E6t5P1vEWm3Zu3WehhgkCm6WO1omOj9BBIs%2fw%0aDSUEZNGrmwf64VZYijfm6gs%2b3EWiINyhWCF9uRORN5NuNquHvDhGHCOc2EnzgYIe%0auYgBP0R6X4phJjS26u8mvMO6qSnKd4wRrOf9ZU73L1VTmhMItshVxH2tuhKurkMV%0ajWDAjWeJfycWe4JVgYxM4GA6g5kKi5nrkhpVEsklh1FJZn65U0aWXUpHAm2ihhKf%0aFq9FgC%2b8Xz8UAtf8JYbAW3D1E%2f0lRZuLt%2b5cosK8b2%2b9CIUNRjYMtyXlbI0RGwl9%0aFO%2f9sv05AoGBAP0jfp8qUqf4u4pkE1W2SzzbQ6oYKYHTMiORVHi2qysgrxAZFKGj%0afW7c7UTpxlCaqqDBRQA%2blZH16xVD3idwYvmw%2f9AKxSozxe3wKbQFRM%2bXYHc7la%2b2%0aTiQiJgjflEadSa57FNgBB7SpeEzaIfmGBYWJXkM%2b6wuaGUz5qZs%2fSFJNAoGBAOLb%0aOuh7CWTk5oISVBfqxnwFEpaMHT5vpzNBwUWUVMhrxNZP3OVSN%2b%2bqKxpJhCF%2fM2no%0aOdxX7CYkrGvHFTvV9WKpa0kYQGms%2bybyoMOYxJax8rV%2bZq9gg2QKwaakoJljaAlX%0a5yUuy32YhLxWodQhE7mlhAUyXIuNLVuYee0Y2ZVzAoGAaV6tBnQHlAPljOW7ZqJL%0aDzn2IIeOP4w6ArQsBVOETJ9%2bP6UxAVecjtlHqrfk5Qh8ng3VOxTSDb%2ff6yok%2fyW5%0aDVawJVlWWQrUCQc%2fVMActIy%2biuMym8G3JTNRwb%2fPaNVwJkD1nDRRkNI6UUM7gTJY%0aeg2EP1mhXWL3xSLnhsgAwsECgYEAqnm2xfeXsqM0%2bbAOU77RE2e4dTuryjybeDBE%0ariXupIIf9DElvYrQkCDfrSxrx8RP%2fZlOyd%2bkjXFnxMJhmYqKkW7hOZeo6ADe54DT%0aAMmvidMFog%2fv2ID9m9NdfP4f1cTW7JaLE%2b0bbDGOJf4wNDn7GbphAIq88v3PhRKL%0aJXpUIDMCgYEA2P7D%2foZu%2bdEPW8JhUsDDXY238ZDbQzWBi6n1uUnMJCnUABd%2fmvuV%0aILR%2fiSBHmt9UdH2YECwry58xFjhXwfTvPc155PiJddjENGFUqohjl0wh0VzLEyfF%0aVb6iVMIdrycD%2fO4U26I3Qco2lQYPoPgrBkAGJ5%2fGCjkTiL0JssoMXa4%3d%0a-----END%20RSA%20PRIVATE%20KEY-----"}],"x-cpanel-api-version":"WHM API 1","summary":"Install SSL certificate for service","operationId":"install_service_ssl_certificate","description":"This function installs a new SSL certificate on a service.\n\n**Important:**\n\nYou **must** restart the selected service after you install a new SSL certificate.","parameters":[{"description":"The service on which to install the SSL certificate.\n\n* `ftp`\n* `exim`\n* `dovecot`\n* `cpanel`\n\n**Important:**\n\nYou **must** restart the selected service after you install a new SSL certificate.","schema":{"enum":["ftp","exim","dovecot","cpanel"],"example":"cpanel","type":"string"},"name":"service","in":"query","required":"true"},{"schema":{"type":"string","format":"pem-certificate","example":"-----BEGIN CERTIFICATE-----\nMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxjZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7GRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+FLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G\n-----END CERTIFICATE-----"},"description":"The certificate to install.\n\n**Note:**\n\nYou **must** URI-encode this value.","required":"true","name":"crt","in":"query"},{"required":"true","in":"query","name":"key","schema":{"type":"string","format":"pem-private-key","example":"-----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-----"},"description":"The certificate's key.\n\n**Note:**\n\nYou **must** URI-encode this value."},{"name":"cabundle","in":"query","required":"false","description":"The certificate's Certificate Authority (CA) bundle.\n\n**Note:**\n\nYou **must** URI-encode this value.","schema":{"type":"string","format":"pem-certificate","default":"","example":"-----BEGIN CERTIFICATE-----\nMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxjZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7GRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+FLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G\n-----END CERTIFICATE-----"}}],"x-cpanel-available-version":"11.40","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","example":"install_service_ssl_certificate","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"}}},"data":{"type":"object","properties":{"service_description":{"description":"The service's description.","example":"Calendar, cPanel, WebDisk, Webmail, and WHM Services","type":"string"},"certificate_info":{"properties":{"domains":{"items":{"example":"example.com","format":"domain","type":"string"},"description":"A list of domains that correspond to the certificate.","type":"array"},"key_algorithm":{"type":"string","description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption"},"issuer.organizationName":{"description":"The certificate's Organization Name.","example":"Organization","type":"string"},"is_self_signed":{"type":"integer","description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — **Not** self-signed.","enum":["1","0"],"example":"1"},"not_before":{"type":"integer","description":"The certificate's validation date.","format":"unix_timestamp","example":"1601467200"},"ecdsa_public":{"type":"string","example":null,"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.","nullable":"true"},"validation_type":{"type":"string","nullable":"true","description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The certificate does not match one of the system’s recognized validation types.","example":"dv","enum":["ev","ov","dv"]},"issuer.commonName":{"type":"string","nullable":"true","description":"The certificate's Common Name.","example":"example.com"},"issuer_text":{"type":"string","example":"localityName\ncity\nemailaddress\nc.example@example.com\nstateOrProvinceName\nstate\ncountryName\nUS\ncommonName\nhostname\norganizationName\ncpanel","description":"The certificate's issuer information."},"signature_algorithm":{"type":"string","description":"The certificate's OID hash algorithm signature.","example":"sha256WithRSAEncryption"},"not_after":{"example":"1601467200","description":"The date the certificate expires.","format":"unix_timestamp","type":"integer"},"modulus":{"type":"string","description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":"true"},"ecdsa_curve_name":{"type":"string","nullable":"true","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.","example":null,"enum":["prime256v1","secp384r1"]},"modulus_length":{"example":"2048","description":"The certificate's key's modulus size, in bits.\n\n* `null` — The certificate's key is **not** an RSA key.","type":"integer"}},"type":"object","description":"An object containing the service's certificate information."},"certificate":{"description":"The SSL certificate's contents.","format":"pem-certificate","example":"-----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-----","type":"string"},"service":{"example":"cpanel","enum":["ftp","exim","dovecot","cpanel"],"description":"The service that the certificate corresponds to.\n\n* `ftp`\n* `exim`\n* `dovecot`\n* `cpanel`","type":"string"}}}}}}}}}}}}},"modsec_enable_vendor_updates":{"paths":{"/modsec_enable_vendor_updates":{"get":{"tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_enable_vendor_updates \\\n  vendor_id='example'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","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","summary":"Enable ModSecurity vendor updates","parameters":[{"required":"true","in":"query","name":"vendor_id","schema":{"example":"example","type":"string"},"description":"The vendor's unique short name."}],"operationId":"modsec_enable_vendor_updates","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"modsec_enable_vendor_updates","description":"The method name called."},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{}}}}}}}},"x-cpanel-available-version":"11.48"}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Vendor Settings","description":"Web Server Security (ModSecurity) / Rule Vendor Settings"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"get_current_users_count":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"88"},"openapi":"3.0.2","x-tagGroups":[{"tags":["Account Creation"],"name":"Accounts"}],"paths":{"/get_current_users_count":{"get":{"summary":"Return cPanel accounts total number","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  get_current_users_count\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_current_users_count?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Account Creation"],"x-cpanel-available-version":"78","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"- `1` - Success\n- `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"get_current_users_count","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"properties":{"users":{"minimum":"0","type":"integer","example":"100","description":"The number of cPanel accounts."}},"type":"object"}},"type":"object"}}}}},"description":"This function returns the number of cPanel accounts on the server.","operationId":"get_current_users_count","parameters":[]}}},"tags":[{"name":"Account Creation","description":"Accounts / Account Creation"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}]},"install_dkim_private_keys":{"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"name":"Mail","tags":["Mail DNS Settings"]}],"paths":{"/install_dkim_private_keys":{"get":{"parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","format":"domain"},"examples":{"single":{"summary":"The domain for which to install an RSA private key to the local server's DKIM record.","value":"example.com"},"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"}},"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."},{"schema":{"example":"AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw","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","required":"true","in":"query","name":"key"}],"operationId":"install_dkim_private_keys","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.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"payload":{"type":"array","items":{"properties":{"msg":{"description":"The RSA private key's installation status message.","example":"Installed Keys","type":"string"},"status":{"type":"integer","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.","example":"1","enum":["0","1"]},"domain":{"type":"string","example":"example.com","description":"The RSA private key's associated domain.","format":"domain"}},"type":"object"},"description":"An array of objects containing information about the RSA private key installation to the local server's DKIM record."}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"type":"string","description":"The method name called.","example":"install_dkim_private_keys"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"78","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","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","summary":"Install existing private key to DKIM record"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"modsec_get_vendors":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/modsec_get_vendors":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return ModSecurity vendors","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_get_vendors\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_vendors?api.version=1"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_vendors","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"vendors":{"type":"array","items":{"type":"object","properties":{"vendor_id":{"type":"string","description":"The vendor's unique short name.","example":"SAMPLE"},"archive_url":{"example":"http://www.example.com/SAMPLE_1415038544.zip","description":"The URL to download the vendor rules.","format":"url","type":"string"},"configs":{"type":"array","items":{"properties":{"vendor_id":{"example":"SAMPLE","description":"The vendor's unique short name.","type":"string"},"config":{"example":"modsec_vendor_configs/SAMPLE/slr_rules/modsecurity_crs_46_slr_et_joomla_attacks.conf","description":"The configuration file path, relative to the `/usr/local/apache/conf` directory.","type":"string"},"active":{"type":"integer","description":"Whether the configuration is active.\n\n* `1` — Active.\n* `0` — Inactive.","example":"1","enum":["1","0"]}},"type":"object"},"description":"A list of information about the configuration files that the vendor provides.","example":[{"active":"1","vendor_id":"SAMPLE","config":"modsec_vendor_configs/SAMPLE/modsecurity_crs_10_setup.conf"},{"active":"0","config":"modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_16_session_hijacking.conf","vendor_id":"SAMPLE"},{"vendor_id":"SAMPLE","config":"modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_46_av_scanning.conf","active":"1"}]},"vendor_url":{"example":"https://www.example.com/index.php/Category:SAMPLE_ModSecurity_Core_Rule_Set_Project","description":"The URL of the vendor's website.","format":"url","type":"string"},"installed_from":{"description":"The URL to the vendor's metadata file.","example":"http://www.example.com/meta_SAMPLE.yaml","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"},"in_use":{"minimum":"0","type":"integer","example":"32","description":"The number of configuration files in the vendor rule set."},"name":{"description":"The vendor's name.","example":"SAMPLE ModSecurity Core Rule Set","type":"string"},"dist_sha512":{"type":"string","example":"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb","description":"The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash."},"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"},"inst_dist":{"type":"string","example":"SAMPLE_1415038544","description":"The rule set version's unique identifier."},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/MD5)\nchecksum value.","example":"ffbaa3a7ead8dfaf0b661a729ce6ad3b","type":"string"},"enabled":{"description":"Whether the vendor is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":["1","0"],"example":"1","type":"integer"},"installed":{"description":"Whether the vendor is installed.\n\n* `1` — Installed.\n* `0` — **Not** installed.","example":"1","enum":["1","0"],"type":"integer"},"supported_versions":{"example":["2.9.1","2.9.2","2.9.3"],"items":{"type":"string"},"description":"A list of the ModSecurity versions that the vendor supports.","type":"array"},"report_url":{"type":"string","example":"https://www.example.com/report","format":"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."},"update":{"description":"Whether the vendor rule set can receive automatic updates.\n\n* `1` — Can receive automatic updates.\n* `0` — **Cannot** receive automatic updates.","example":"1","enum":["1","0"],"type":"integer"},"description":{"type":"string","description":"The ModSecurity vendor's description.","example":"A SAMPLE-curated ModSecurity rule set."}}},"description":"An array of objects that represent the list of configured vendors on the system."}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.46","parameters":[],"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"}}},"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Vendor Settings"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Rule Vendor Settings","description":"Web Server Security (ModSecurity) / Rule Vendor Settings"}]},"modsec_report_rule":{"x-tagGroups":[{"name":"Web Server Security (ModSecurity)","tags":["Rule Settings"]}],"paths":{"/modsec_report_rule":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Export ModSecurity rule error report","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","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"},{"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","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.48","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"report":{"description":"An array of objects containing information for the report.","items":{"type":"object","properties":{"hits":{"type":"array","items":{"properties":{"timestamp":{"example":"2019-10-13T07:58:04","format":"ISO-8601 Date Time (Space Separated)","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.","type":"string"},"meta_line":{"minimum":"1","type":"integer","description":"The line number of the ModSecurity rule that triggered the log entry.","example":"1"},"handler":{"nullable":"true","example":null,"description":"This parameter only returns a `null` value.","type":"string"},"id":{"example":"794828","description":"The `modsec` database line number.","minimum":"1","type":"integer"},"path":{"example":"/something","description":"The accessed file's path, relative to the document root.","type":"string"},"ip":{"type":"string","example":"10.215.215.236","format":"ipv4","description":"The client's IP address."},"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"},"meta_uri":{"example":null,"description":"The client-requested URI.\n\n**Note:**\n\nThis data is not always available.","format":"uri","nullable":"true","type":"string"},"http_version":{"type":"string","description":"The HTTP version number.","example":"HTTP/1.1"},"meta_severity":{"type":"string","nullable":"true","example":"CRITICAL","enum":["ALERT","CRITICAL","DEBUG","EMERGENCY","ERROR","INFO","NOTICE","WARNING"],"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`"},"meta_rev":{"description":"The revision number from the ModSecurity rule's `rev` action.","example":"1","nullable":"true","minimum":"1","type":"integer"},"justification":{"type":"string","example":"Unconditional match in SecAction.","description":"The specific criteria from the ModSecurity rule that generated the hit."},"host":{"type":"string","example":"example.com","format":"domain","description":"The virtual host's (vhost) domain name."},"meta_msg":{"type":"string","description":"The human-readable message from the ModSecurity rule's `msg` action.","example":"Method is not allowed by policy","nullable":"true"},"meta_id":{"example":"12345694","description":"The ID of the ModSecurity rule that triggered the log entry.","type":"integer"},"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"},"meta_file":{"type":"string","example":"/usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf","description":"The ModSecurity configuration file that contains the rule that triggered the log entry."},"timezone":{"type":"string","example":"-300","description":"The server's configured timezone, in minutes difference from UTC/GMT."},"meta_offset":{"example":"0","description":"The byte offset at which a match occurred within the target\ndata.\n\n**Note:**\n\nThis data is not always available.","minimum":"0","type":"integer"},"action_desc":{"type":"string","example":"Access denied with code 406 (phase 2).","description":"The web server's response to the client."},"meta_logdata":{"type":"string","description":"The transaction data fragment from the ModSecurity rule's `logdata` action.","example":null,"nullable":"true"}},"type":"object"},"description":"An array of objects containing information about the hit."},"rule_text":{"type":"string","example":"SecAction \"deny,auditlog,id:'12345694'\"\n","description":"The rule text from the configuration file."},"message":{"type":"string","example":"Hi. We're having some trouble with this rule. It seems to be blocking all requests.","description":"A short message that explains the reason for the report."},"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"},"email":{"example":"john.doe@example.com","description":"The contact email address to send with the error report. This allows the rule's vendor to reply to the report directly.","format":"email","type":"string"}}}}}},"metadata":{"properties":{"command":{"type":"string","example":"modsec_report_rule","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"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.","style":"form","in":"query","name":"row_ids","required":"true","examples":{"multiple":{"value":"794828, 794829, 794820","summary":"Report multiple row IDs."},"single":{"value":"794828","summary":"Report a single row ID."}},"explode":"false","schema":{"type":"integer"}},{"description":"A short message that explains the reason for the report.","schema":{"type":"string","example":"Hi. We're having some trouble with this rule. It seems to be\nblocking all requests."},"name":"message","in":"query","required":"true"},{"in":"query","name":"email","required":"true","description":"The contact email address to send with the error report. This allows the rule's vendor to reply to the user directly.","schema":{"format":"email","example":"john.doe@example.com","type":"string"}},{"in":"query","name":"type","required":"true","description":"The report's type.\n\n**Note:**\n\nThis value does **not** use a specified format. Treat the value as freeform text.","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.","schema":{"enum":["1","0"],"example":"1","type":"integer"},"in":"query","name":"send","required":"true"}]}}},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"modsec_deploy_rule_changes":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/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":[{"in":"query","name":"config","required":"true","description":"The ModSecurity configuration file's path and name, relative to the `/usr/local/apache/conf/` directory.","schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}}],"x-cpanel-available-version":"11.46","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"modsec_deploy_rule_changes","type":"string"},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}}}},"tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_deploy_rule_changes \\\n  config='modsec_vendor_configs/example.conf'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_deploy_rule_changes?api.version=1&config=modsec_vendor_configs%2fexample.conf","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable staged ModSecurity rule changes"}}},"tags":[{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}}}]},"ipv6_disable_account":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/ipv6_disable_account":{"get":{"summary":"Remove IPv6 address range from account","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  ipv6_disable_account \\\n  user='user1,user2,user3'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_disable_account?api.version=1&user=user1%2cuser2%2cuser3","label":"URL","lang":"HTTP"}],"tags":["IP Addresses","IPv6 Address Settings"],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"fail_cnt":{"example":"0","description":"The number of accounts that failed to disable IPv6.\n\n**Note**\n\nThe function only returns this value if any failures exist.","type":"integer","minimum":"0"},"failures":{"type":"array","items":{"type":"object","properties":{"name":{"example":"user1","description":"The name of the account where IPv6 disable failed","format":"username","type":"string"},"reason":{"description":"The reason for the IPv6 disable failure","example":"The “user1” account does not exist."}}},"description":"List of accounts where IPv6 disable failed\n\n**Note**\n\nThe function only returns this value if any failures exist."}},"type":"object"},"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"ipv6_disable_account","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.40","parameters":[{"description":"A comma delimited list of account names.","schema":{"example":"user1,user2,user3","type":"string"},"in":"query","name":"user","required":"true"}],"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"}}},"x-tagGroups":[{"tags":["IPv6 Address Settings"],"name":"IP Address Management"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"name":"IPv6 Address Settings","description":"IP Address Management / IPv6 Address Settings"}]},"list_staged_services_cluster_nodes":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/list_staged_services_cluster_nodes":{"get":{"summary":"List staged services cluster nodes","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  list_staged_services_cluster_nodes\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_staged_services_cluster_nodes","lang":"HTTP","label":"URL"}],"tags":["ServicesCluster"],"x-cpanel-available-version":"11.110","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"list_staged_services_cluster_nodes","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"}}},"data":{"properties":{"nodes":{"description":"An array of objects containing staged services cluster nodes.","items":{"properties":{"role":{"example":"server","enum":["server","agent"],"description":"* `server` - The node is acting as a server node in the cluster.\n* `agent` - The node is acting as an agent node in the cluster.","type":"string"},"ip_address":{"description":"The node's internal IP address.","format":"ipv4","example":"10.0.1.1","type":"string"},"ssh_key":{"example":"id_rsa","description":"The name of the SSH key the system uses for authentication during deployment.","type":"string"},"name":{"pattern":"^[a-z][a-z0-9]*$","type":"string","description":"A friendly name for the node.","example":"server1"}}}}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"list_staged_services_cluster_nodes","description":"This function lists staged Services Cluster nodes.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","parameters":[],"x-cpanel-internal-only":"true"}}},"x-tagGroups":[{"name":"ServicesCluster","tags":["ServicesCluster"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The ServicesCluster module for WHM API 1.","name":"ServicesCluster"},{"description":"ServicesCluster","name":"ServicesCluster"}]},"massmodifyacct":{"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"paths":{"/massmodifyacct":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update multiple cPanel accounts","tags":["Accounts","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  massmodifyacct \\\n  user='username'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/massmodifyacct?api.version=1&username=username"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payload":{"type":"array","example":[{"result":"0","user":"username","reason":"Unable to fetch the cPanel user file for username"},{"result":"1","user":"username1","reason":"Account Modified","warnings":[],"extended":{"setshell":"unmodified","domain":"example1.com","cpuser":{"CONTACTEMAIL2":"","HASDKIM":"1","MAXSUB":"unlimited","STARTDATE":"765435600","HASCGI":"1","PLAN":"extended","MTIME":"1584509675","DEMO":"0","MAXSQL":"345","DBOWNER":"username1","UTF8MAILBOX":"1","DISK_BLOCK_LIMIT":"0","DEADDOMAINS":["example.example1.com"],"MAILBOX_FORMAT":"maildir","DOMAIN":"example1.com","BACKUP":"1","RS":"jupiter","MXCHECK-example1.com":"remote","HASDMARC":"1","MAXLST":"unlimited","MAXFTP":"234","USER":"username1","LEGACY_BACKUP":"0","MAX_DEFER_FAIL_PERCENTAGE":"unlimited","__CACHE_DATA_VERSION":"0.81","_PACKAGE_EXTENSIONS":"custom","FEATURELIST":"default","HASSPF":"1","MAX_EMAILACCT_QUOTA":"unlimited","IP":"172.16.1.3","LANG":"english-utf8","OWNER":"username1","HOMEDIRLINKS":[],"CONTACTEMAIL":"username1@example.com","MAXADDON":"0","MAX_EMAIL_PER_HOUR":"unlimited","MAXPARK":"0","BWLIMIT":"unlimited","LOCALE":"en","DOMAINS":[],"MAXPOP":"123","WORKER_NODE-Mail":"example1:6L3ZJZ8LPAAOMC8CA31325O8EKGJ5YV5"},"user":"username1"},"messages":[]},{"proxied_from":["example.com"],"extended":{"domain":"example2.com","cpuser":{"__CACHE_DATA_VERSION":"0.81","FEATURELIST":"default","_PACKAGE_EXTENSIONS":"","HASSPF":"1","MXCHECK-example2.com":"0","MAX_EMAILACCT_QUOTA":"unlimited","LANG":null,"IP":"10.0.0.1","CONTACTEMAIL":"","MAXADDON":"0","HOMEDIRLINKS":[],"OWNER":"root","LOCALE":"cs","DOMAINS":[],"BWLIMIT":"unlimited","MAXPARK":"0","MAX_EMAIL_PER_HOUR":"unlimited","WORKER_NODE-Mail":"example2:BXE4LIAXF4X9N0B0TG69AAQ64DGR1XPU","MAXPOP":"123","MAXSUB":"unlimited","HASDKIM":"1","CONTACTEMAIL2":"","STARTDATE":"728719200","MTIME":"1583966719","PLAN":"extended","HASCGI":"0","DBOWNER":"username2","DEMO":"0","MAXSQL":"345","DOMAIN":"example2.com","MAILBOX_FORMAT":"maildir","UTF8MAILBOX":"1","DISK_BLOCK_LIMIT":"0","DEADDOMAINS":[],"HASDMARC":"1","BACKUP":"1","RS":"jupiter","MAX_DEFER_FAIL_PERCENTAGE":"unlimited","LEGACY_BACKUP":"0","USER":"username2","MAXFTP":"234","MAXLST":"unlimited"},"user":"username2","setshell":"unmodified"},"result":"1","user":"username2","reason":"Account Modified","messages":[],"warnings":[]},{"result":"1","reason":"Account Modified","user":"username2","warnings":[],"extended":{"setshell":"unmodified","user":"username2","cpuser":{"LOCALE":"en","DOMAINS":[],"BWLIMIT":"unlimited","MAXPARK":"unlimited","MAX_EMAIL_PER_HOUR":"unlimited","WORKER_NODE-Mail":"example2:H99IZWY3OH9Q1DQNR58L55WUBXAENPDP","MAXPOP":"123","LANG":"english-utf8","IP":"172.16.1.3","CONTACTEMAIL":"","MAXADDON":"unlimited","HOMEDIRLINKS":[],"OWNER":"username2","HASSPF":"1","MXCHECK-example2.com":"remote","MAX_EMAILACCT_QUOTA":"unlimited","__CACHE_DATA_VERSION":"0.81","FEATURELIST":"default","_PACKAGE_EXTENSIONS":"","HASDMARC":"1","RS":"jupiter","BACKUP":"1","MAX_DEFER_FAIL_PERCENTAGE":"unlimited","USER":"username2","LEGACY_BACKUP":"0","MAXFTP":"234","MAXLST":"unlimited","DBOWNER":"username2","MAXSQL":"345","DEMO":"0","DOMAIN":"example2.com","MAILBOX_FORMAT":"maildir","DEADDOMAINS":[],"UTF8MAILBOX":"1","DISK_BLOCK_LIMIT":"0","MTIME":"1584509675","PLAN":"default","HASCGI":"1","MAXSUB":"unlimited","HASDKIM":"1","CONTACTEMAIL2":"","STARTDATE":"765435600"},"domain":"example2.com"},"messages":[]},{"result":"1","extended":{"user":"username2","cpuser":{"STARTDATE":"765435600","HASDKIM":"1","CONTACTEMAIL2":"","MAXSUB":"unlimited","HASCGI":"0","PLAN":"default","MTIME":"1583966717","DISK_BLOCK_LIMIT":"0","UTF8MAILBOX":"1","DEADDOMAINS":[],"MAILBOX_FORMAT":"maildir","DOMAIN":"example2.com","DEMO":"0","MAXSQL":"345","DBOWNER":"username2","MAXFTP":"234","MAXLST":"unlimited","USER":"username2","LEGACY_BACKUP":"0","MAX_DEFER_FAIL_PERCENTAGE":"unlimited","RS":"jupiter","BACKUP":"1","HASDMARC":"1","_PACKAGE_EXTENSIONS":"","FEATURELIST":"default","__CACHE_DATA_VERSION":"0.81","MAX_EMAILACCT_QUOTA":"unlimited","MXCHECK-example2.com":"0","HASSPF":"1","OWNER":"linked","HOMEDIRLINKS":[],"CONTACTEMAIL":"","MAXADDON":"unlimited","IP":"10.0.0.2","LANG":"english-utf8","MAXPOP":"123","MAX_EMAIL_PER_HOUR":"unlimited","MAXPARK":"unlimited","BWLIMIT":"unlimited","DOMAINS":[],"LOCALE":"en"},"domain":"example2.com","setshell":"noshell"},"proxied_from":["example.com"],"warnings":[],"messages":["Shell changed"],"user":"username2","reason":"Account Modified"}],"description":"An array of objects containing data for each modified user.\n\n**Note:**\n\nIf an account uses [linked cPanel server nodes](https://go.cpanel.net/whmdocsLinkServerNodes),\nthis object contains a return for each server on which the account exists.","items":{"type":"object","properties":{"result":{"enum":["1","0"],"description":"Whether the account modification succeeded.\n* `1` — Success.\n* `0` — Failure.","type":"integer"},"extended":{"description":"An object containing the account's modified settings.","type":"object","properties":{"cpuser":{"description":"An object containing the output of an account's `cpuser`\nfile. The system stores this file in the `/var/cpanel/users`\ndirectory.\n\n**Note:**\n\nIf the account or its hosting plan use\n[package extensions](https://go.cpanel.net/GuidetoPackageExtensions),\nthe `cpuser` object will also include the extension's variables.","additionalProperties":{"description":"The complete attributes of the cPanel account."},"type":"object"},"user":{"type":"string","description":"The cPanel account's username.\n\n**Note:**\n\nIf you changed the cPanel account's username, the function\nreturns the new value.","format":"username"},"domain":{"type":"string","description":"The account's main domain.","format":"domain"},"setshell":{"type":"string","anyOf":[{"description":"The updated shell's absolute file path.","format":"path","type":"string"},{"enum":["unmodified","noshell"],"description":"The shell's absolute filepath did not change.","type":"string"}],"format":"path","description":"The absolute file path to the account's updated shell location.\n\n* `unmodified` — The shell's absolute filepath did not change."}}},"proxied_from":{"type":"array","items":{"format":"domain","type":"string"},"description":"The hostnames of the\n[linked cPanel server nodes](https://go.cpanel.net/serverroles)\nfrom which the function proxied the return. The function returns\nthe hostnames in their proxied order.\n\n**Note:**\n\nThe function **only** returns this value for\n[distributed cPanel accounts](https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account)."},"warnings":{"type":"array","items":{"type":"string"},"description":"A list of warning messages for the modified account, if any exist."},"messages":{"type":"array","items":{"type":"string"},"description":"A list containing account modification messages."},"user":{"description":"The modified account's username.","format":"username","type":"string"},"reason":{"type":"string","description":"The account's modification status."}}}}}},"metadata":{"example":{"warnings":[],"messages":["From example1.com: Restarting apache"],"reason":"Failed to modify one or more users.","version":"1","command":"massmodifyacct","result":"0"},"properties":{"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"massmodifyacct","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Failed to modify one or more users."}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"88","parameters":[{"required":"true","in":"query","name":"user","schema":{"type":"string","format":"username"},"examples":{"single":{"summary":"Modify a single user.","value":"username"},"multiple":{"summary":"Modify multiple users.","value":"user-0=username user-1=username1 user-2=username2 user-3=username3"},"multiple-alternative":{"value":"user=username user=username1 user=username2 user=username3","summary":"Modify multiple users."}},"description":"The account's current username.\n\n**Note:**\n\nTo modify multiple users, duplicate or increment the parameter name. For example,\nthe `user-1`, `user-2`, and `user-3` parameters."},{"in":"query","name":"BACKUP","required":"false","description":"Whether backups are enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nThis parameter **requires** `root` privileges.","example":"1","schema":{"enum":["1","0"]}},{"schema":{"$ref":"#/components/schemas/IntPosNullOrUnlimited"},"description":"The account's maximum bandwidth use, in bytes.\n\n* `0`, `null` or `unlimited` — The account can use unlimited bandwidth.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"BWLIMIT"},{"schema":{"example":"username@example.com","format":"email","type":"string"},"description":"The account's contact email address.\n\nThis parameter defaults to the defined system value.","required":"false","name":"CONTACTEMAIL","in":"query"},{"schema":{"enum":["1","0"],"example":"1","type":"integer"},"description":"Whether CGI access is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nWhen a [server profile](https://go.cpanel.net/whmdocsServerProfile) disables the\n[Web Server](https://go.cpanel.net/serverroles#roles) role, you **cannot** enable\nCGI access.","required":"false","name":"HASCGI","in":"query"},{"schema":{"type":"integer","enum":["1","0"]},"description":"Whether DomainKeys Identified Mail (DKIM) is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","required":"false","name":"HASDKIM","in":"query"},{"name":"HASDMARC","in":"query","required":"false","description":"Whether Domain-based Message Authentication, Reporting, and Conformance (DMARC) is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["1","0"]}},{"description":"Whether shell (SSH) access is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nWe **strongly** recommend that you use the `shell` parameter to specify a shell for\nSSH access.","schema":{"example":"1","enum":["1","0"],"type":"integer"},"name":"HASSHELL","in":"query","required":"false"},{"required":"false","name":"HASSPF","in":"query","schema":{"type":"integer","enum":["1","0"],"example":"1"},"description":"Whether Sender Policy Framework (SPF) is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value."},{"required":"false","in":"query","name":"LOCALE","schema":{"type":"string","format":"ISO-3166-1 (alpha-2)","example":"en"},"description":"The account's default locale.\n\nThis parameter defaults to the defined system value."},{"in":"query","name":"MAXADDON","required":"false","description":"The account's maximum number of addon domains.\n\n* `0`, `null`, or `unlimited` — The account possesses unlimited addon domains.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"}},{"description":"The account's maximum number of FTP accounts.\n\n* `null` or `unlimited` — The account possesses unlimited FTP accounts.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"},"in":"query","name":"MAXFTP","required":"false"},{"description":"The account's maximum number of mailing lists.\n\n* `0`, `null`, or `unlimited` — The account possesses unlimited mailing lists.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"},"name":"MAXLST","in":"query","required":"false"},{"schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"},"description":"The account's maximum number of parked domains (aliases).\n\n* `null` or `unlimited` — The account possesses unlimited mailing lists.\n\nThis parameter defaults to the defined system value.","required":"false","name":"MAXPARK","in":"query"},{"description":"The account's maximum number of Ruby applications.\n\n* `null` or `unlimited` — The account possesses unlimited Ruby applications.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"},"name":"MAXPASSENGERAPPS","in":"query","required":"false"},{"description":"The maximum number of email accounts for the account.\n\n* `null` or `unlimited` — The account possesses unlimited email accounts.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"},"in":"query","name":"MAXPOP","required":"false"},{"required":"false","in":"query","name":"MAXSQL","schema":{"$ref":"#/components/schemas/Int0Max999999NullOrUnlimited"},"description":"The maximum number of each available type of SQL database for the account.\n\nFor example, if you set this value to `5` and the system administrator allows MySQL®\nand PostgreSQL® databases, users can create up to five MySQL databases and up to five\nPostgreSQL databases.\n\n* `null` or `unlimited` — The account possesses unlimited databases.\n\nThis parameter defaults to the defined system value."},{"description":"The maximum number of subdomains for the account.\n\n* `null` or `unlimited` — The account possesses unlimited subdomains.\n\nThis parameter defaults to the defined system value.","schema":{"$ref":"#/components/schemas/Int0-999999NullOrUnlimited"},"name":"MAXSUB","in":"query","required":"false"},{"required":"false","in":"query","name":"MAX_EMAIL_PER_HOUR","schema":{"$ref":"#/components/schemas/IntPosOrUnlimited"},"description":"The maximum number of emails that the account can send in one hour.\n\n* `0` or `unlimited` — The account can send an unlimited number of emails.\n\nThis parameter defaults to the defined system value."},{"description":"The maximum size, in megabytes (MB), that the account can define when it creates an\nemail account.\n\n* `unlimited` — The account possesses an unlimited quota.\n\n**Important:**\n\n* This value applies to each email account, **not** each cPanel account.\n* If you specify a `MAX_EMAILACCT_QUOTA` value, the function will **overwrite** the\nplan's defined value for that cPanel account.\n* This parameter does **not** affect any existing email accounts\n* We recommend that you allow the account's plan to determine this value.\n* `MAX_EMAIL_PER_HOUR` will define to unlimited if you do **not** define either the plan\nor `MAX_EMAILACCT_QUOTA` parameters.\n\nThis parameter defaults to the defined system value. It will default to `unlimited` if\nyou do **not** define either the `plan` or `MAX_EMAILACCT_QUOTA` parameters.","schema":{"example":"unlimited","oneOf":[{"type":"string","enum":["unlimited"]},{"minimum":"1","type":"integer","maximum":"4294967296"}]},"name":"MAX_EMAILACCT_QUOTA","in":"query","required":"false"},{"schema":{"example":"0","enum":["0","1"],"default":"1","type":"integer"},"description":"Whether to modify the firewall rules as part of the account modification.\n\n* `1` – Modify the firewall rules.\n* `0` – Do **not** modify the firewall rules.\n\n**NOTE:**\n\nIf you do not set this parameter, the system will modify the firewall based on the *Do not make changes to the firewall during account modification.* setting in WHM's [*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).","required":"false","in":"query","name":"modify_firewall"},{"schema":{"$ref":"#/components/schemas/IntPosOrUnlimited"},"description":"The percentage of failed or deferred email messages that the account can send per hour\nbefore outgoing mail is rate-limited.\n\n* `0` or `unlimited` — The account can send an unlimited number of failed or deferred\nmessages.\n\nThis parameter defaults to the defined system value.","required":"false","name":"MAX_DEFER_FAIL_PERCENTAGE","in":"query"},{"description":"A new owner's username or the `root` user, to change the account's owner.\n\nThis parameter defaults to the defined system value.\n\n**Note:**\n\nThe authenticated user **must** have `root` privileges in order to assign the account\nto a reseller other than that account.","schema":{"format":"username","example":"reseller","type":"string"},"in":"query","name":"OWNER","required":"false"},{"required":"false","in":"query","name":"QUOTA","schema":{"$ref":"#/components/schemas/IntPosNullOrUnlimited"},"description":"The account's disk space quota, in multiples of 1,048,576 bytes.\n\n* `0`, `null`, or `unlimited` — The account's disk space is unlimited.\n\nThis parameter defaults to the defined system value."},{"required":"false","name":"remove_missing_extensions","in":"query","schema":{"type":"string","example":"packageext1 packageext2"},"description":"A space-separated list of removed, missing, or uninstalled extensions.\n\nThis parameter defaults to the defined system value.\n\n**Warning:**\n\nThis parameter removes all of the extensions that you list from\nthe `_PACKAGE_EXTENSIONS` variable in the user file. It will **not** remove the\nextensions' variables. For more information, read our\n[Guide to Package Extensions](https://go.cpanel.net/GuidetoPackageExtensions)."},{"name":"rename_database_objects","in":"query","required":"false","description":"Whether to rename the cPanel account's database objects to use a new username's\ndatabase prefix. This parameter **only** applies to servers that use database prefixing.\n\n* `1` — Rename the cPanel account's database objects.\n* `0` — Do **not** rename the cPanel account's database objects.\n\n**Warning:**\n\n* The account owner **must** update any applications to use the new database object names.\n* **Use this parameter carefully**. It can cause confusion for system administrators.\n\nMySQL does **not** allow you to rename a database. When cPanel & WHM \"renames\" a database,\nthe system performs the following steps:\n\n1. The system creates a new database.\n1. The system moves data from the old database to the new database.\n1. The system recreates grants and stored code in the new database.\n1. 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\nrestore the database's original state. If the restoration process fails, the API function's\nerror response describes these additional failures.\n* In rare cases, the system creates the second database successfully, but fails to delete\nthe old database or grants. The system treats the rename action as a success; however, the\nAPI function returns warnings that describe the failure to delete the old database or grants.","schema":{"example":"0","enum":["1","0"],"type":"integer"}},{"name":"reseller","in":"query","required":"false","description":"Whether to grant reseller privileges to the account.\n\n* `1` — Grant reseller privileges.\n* `0` — Do **not** grant reseller privileges.","schema":{"type":"integer","default":"0","enum":["1","0"],"example":"1"}},{"in":"query","name":"shell","required":"false","description":"The absolute file path to the shell's location.\n\nThis parameter defaults to the defined system value.","schema":{"example":"/bin/bash","format":"path","type":"string"}},{"description":"Whether Apache SpamAssassin™ is enabled for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","example":"1","enum":["1","0"]},"name":"spamassassin","in":"query","required":"false"},{"in":"query","name":"RS","required":"false","description":"The account's cPanel interface theme.\n\nThis parameter defaults to the defined system value.","schema":{"example":"jupiter","type":"string"}},{"required":"false","in":"query","name":"DBOWNER","schema":{"type":"string","example":"example","format":"username"},"description":"The owner of the account's MySQL® databases.\n\nThis parameter defaults to the defined system value."},{"schema":{"example":"100000000","minimum":"1","type":"integer"},"description":"The number of disk blocks for the account, in kilobytes (KB).\n\nThis parameter defaults to the defined system value.","required":"false","name":"DISK_BLOCK_LIMIT","in":"query"},{"description":"The account's display language.\n\nThis parameter defaults to the defined system value.","schema":{"type":"string","example":"english-utf8"},"name":"LANG","in":"query","required":"false"},{"schema":{"enum":["maildir","mbox"]},"description":"The storage format that the account's mailboxes use.\n\n* `maildir`\n* `mbox`\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"MAILBOX_FORMAT"},{"description":"The priority of the account's primary mail exchanger.\n\n**Note:**\n\nThe parameter name consists of `MXCHECK`, a hyphen, and the primary domain of the\naccount.\n\nExample key and value:\n* `MXCHECK-example.com=10`\n\nThis parameter defaults to the define system value.","schema":{"type":"integer","minimum":"0","example":"1"},"in":"query","name":"MXCHECK-*","required":"false"},{"name":"OUTGOING_EMAIL_SUSPENDED","in":"query","required":"false","description":"Whether to suspend outgoing email on the account.\n\n* `1` — Suspend outgoing email.\n* `0` — Do **not** suspend outgoing email.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["1","0"],"example":"0"}},{"in":"query","name":"PUSHBULLET_ACCESS_TOKEN","required":"false","description":"An access token for the account's [Pushbullet](https://www.pushbullet.com/)™\nnotifications.\n\nThis parameter defaults to the defined system value.","schema":{"example":"1234567890","type":"string"}},{"schema":{"example":"0","enum":["1","0"],"type":"integer"},"description":"Whether to send a notification when someone links the account to an external\nauthentication account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","required":"false","name":"notify_account_authn_link","in":"query"},{"description":"Whether to send a notification when someone disables notifications for external\nauthentication account links.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","example":"0","enum":["1","0"]},"in":"query","name":"notify_account_authn_link_notification_disabled","required":"false"},{"name":"notify_autossl_expiry","in":"query","required":"false","description":"Whether to send a notification when an AutoSSL certificate expires.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","example":"0","enum":["1","0"]}},{"schema":{"enum":["1","0"],"example":"0","type":"integer"},"description":"Whether to send a notification AutoSSL cannot renew a certificate because domains\nthat fail Domain Control Validation (DCV) exist on the current certificate.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"notify_autossl_expiry_coverage"},{"description":"Whether to send a notification when AutoSSL renews a certificate.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"example":"0","enum":["1","0"],"type":"integer"},"name":"notify_autossl_renewal","in":"query","required":"false"},{"schema":{"type":"integer","enum":["1","0"],"example":"0"},"description":"Whether to send a notification when AutoSSL renews a certificate but the new\ncertificate lacks at least one domain that the previous certificate secured.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","required":"false","in":"query","name":"notify_autossl_renewal_coverage"},{"required":"false","name":"notify_contact_address_change","in":"query","schema":{"type":"integer","enum":["1","0"],"example":"0"},"description":"Whether to send a notification when someone changes the contact address for the account.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value."},{"required":"false","in":"query","name":"notify_contact_address_change_notification_disabled","schema":{"example":"0","enum":["1","0"],"type":"integer"},"description":"Whether to send a notification when disables the notification for contact address\n changes.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value."},{"description":"Whether to send a notification when the account reaches its disk usage limit.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"type":"integer","enum":["1","0"],"example":"0"},"in":"query","name":"notify_disk_limit","required":"false"},{"in":"query","name":"notify_password_change","required":"false","description":"Whether to send a notification when someone changes the account's password.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["1","0"],"example":"0","type":"integer"}},{"in":"query","name":"notify_password_change_notification_disabled","required":"false","description":"Whether to send a notification when someone disables notifications for password changes.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["1","0"],"example":"0","type":"integer"}},{"name":"notify_ssl_expiry","in":"query","required":"false","description":"Whether to send a notification when an SSL certificate on the account expires.\n\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the defined system value.","schema":{"enum":["1","0"],"example":"0","type":"integer"}},{"required":"false","in":"query","name":"STARTDATE","schema":{"example":"1549471343","format":"unix_timestamp","type":"integer"},"description":"A timestamp for which to use as the account's creation date.\n\nThis parameter defaults to the defined system value."},{"in":"query","name":"STYLE","required":"false","description":"The account's cPanel interface style.\n\nThis parameter defaults to the defined system value.","schema":{"example":"Glass","type":"string"}}],"operationId":"massmodifyacct","description":"This function modifies multiple cPanel accounts.\n\n**Warning:**\n\n* We **strongly** recommend that you do not modify a cPanel account's settings\nif that account uses a hosting plan (package). If the package values change, the\nsystem will overwrite any of your custom values with the package's new values.\n* This function uses case-sensitive parameters. You **must** enter parameters in\nthe correct case format. If you do not, the function will ignore that parameter.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of\nSPF resource records 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). CentOS 7\n  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\n  version of BIND that complies with RFC 7208. To resolve this issue, update your\n  operating system to a version that contains the updated version of BIND. For more\n  information, read the [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164)."}}},"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"name":"Account Management","description":"Accounts / Account Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{"IntPosNullOrUnlimited":{"example":"unlimited","oneOf":[{"enum":["null"]},{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}]},"Int0Max999999NullOrUnlimited":{"oneOf":[{"enum":["null"]},{"type":"string","enum":["unlimited"]},{"maximum":"999999","type":"integer","minimum":"1"}],"example":"unlimited"},"Int0-999999NullOrUnlimited":{"oneOf":[{"enum":["null"]},{"enum":["unlimited"],"type":"string"},{"maximum":"999999","type":"integer","minimum":"0"}],"example":"unlimited"},"IntPosOrUnlimited":{"example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}]}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"backup_user_list":{"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup Settings","description":"Backups / Backup Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Backups","tags":["Backup Settings"]}],"paths":{"/backup_user_list":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  backup_user_list \\\n  restore_point='2014-10-10T00:00:00.000Z'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_user_list?api.version=1&restore_point=2014-10-10T00%3a00%3a00.000Z"}],"tags":["Backups","Backup Settings"],"summary":"Return users with a backup file","x-cpanel-api-version":"WHM API 1","parameters":[{"description":"The desired date.","schema":{"format":"ISO-8601 Date","example":"2014-10-10T00:00:00.000Z","type":"string"},"name":"restore_point","in":"query","required":"true"}],"description":"This function lists users with a backup file, stored locally or on additional backup destinations, on a specified date.","operationId":"backup_user_list","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"user":{"items":{"properties":{"status":{"type":"string","enum":["active","inactive","no_backup"],"example":"active","description":"The account's backup status\n* `active`\n* `inactive`\n* `no_backup`"},"username":{"type":"string","description":"The user's username.","format":"username","example":"username"}},"type":"object"},"description":"An array of objects containing user backup information.","type":"array"}},"type":"object"},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"backup_user_list","description":"The method name called."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"verify_new_username":{"tags":[{"description":"Accounts / Account Creation","name":"Account Creation"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Accounts","tags":["Account Creation"]}],"paths":{"/verify_new_username":{"get":{"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"}],"tags":["Account Creation"],"summary":"Validate new cPanel account username","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","name":"user","in":"query","schema":{"type":"string","example":"username"},"description":"The account that you wish to create."}],"description":"This function checks for username conflicts during account creation.","operationId":"verify_new_username","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"verify_new_username","description":"The method name called.","type":"string"},"result":{"type":"integer","description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"reason":{"type":"string","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"}}}}}}}}},"x-cpanel-available-version":"58"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"88","description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"convert_and_migrate_from_legacy_config":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"x-tagGroups":[{"tags":["Legacy Migration"],"name":"Backups"}],"paths":{"/convert_and_migrate_from_legacy_config":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  convert_and_migrate_from_legacy_config\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_and_migrate_from_legacy_config?api.version=1"}],"tags":["Backups","Legacy Migration"],"summary":"Migrate server to new backup system","x-cpanel-api-version":"WHM API 1","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.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"in":"query","name":"no_convert","required":"false"}],"x-cpanel-available-version":"64","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"convert_and_migrate_from_legacy_config"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"Legacy Backup configuration was renamed from /etc/cpbackup.conf to /etc/cpbackup.conf-1485958451 as a backup copy for your records.","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}}}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Legacy Migration","name":"Legacy Migration"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"get_application_contact_importance":{"openapi":"3.0.2","info":{"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Notifications","description":"Server Administration / Notifications"}],"paths":{"/get_application_contact_importance":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_application_contact_importance \\\n  app='Check'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_importance?api.version=1&app=Check","lang":"HTTP","label":"URL"}],"tags":["Server Administration","Notifications"],"summary":"Return app contact importance setting","x-cpanel-api-version":"WHM API 1","operationId":"get_application_contact_importance","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.","parameters":[{"description":"The cPanel & WHM application module's name.","schema":{"example":"Check","type":"string"},"name":"app","in":"query","required":"true"}],"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"get_application_contact_importance","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"name":{"type":"string","description":"The text version of the importance setting.\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`","example":"Disabled","enum":["High","Medium","Low","Disabled"]},"importance":{"type":"integer","example":"0","enum":["1","2","3","0"],"description":"The importance level at which to send the notification.\n* `1` — High.\n* `2` — Medium.\n* `3` — Low.\n* `0` — Disabled."}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Server Administration","tags":["Notifications"]}]},"cpsc_install_base_package":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.111.0.9999"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"description":"cPCloud related WHM API 1 functions.","name":"cPCloud"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"cPCloud","tags":["cPCloud"]}],"paths":{"/cpsc_install_base_package":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  cpsc_install_base_package \\\n  service=database\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_install_base_package?api.version=1&service=database","lang":"HTTP","label":"URL"}],"tags":["cPCloud"],"summary":"Install a cPCloud Service package.","x-cpanel-api-version":"WHM API 1","operationId":"cpsc_install_base_package","description":"This function installs the package associated with the specified cPanel Services Cluster service.","x-cpanel-internal-only":"true","parameters":[{"required":"true","name":"service","in":"query","schema":{"example":"database","type":"string"},"description":"The name of the service package to install."}],"x-cpanel-available-version":"11.114","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"cpsc_install_base_package","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}},"data":{"type":"object","properties":{"logfile":{"example":"/var/log/cpanel/services.log","description":"The file location of the log that contains the output of the package install.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}}},"validate_system_user":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Transfers","description":"The Transfers module for WHM API 1."},{"name":"Transfer Configuration","description":"Transfers / Transfer Configuration"}],"paths":{"/validate_system_user":{"get":{"tags":["Transfers","Transfer Configuration"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  validate_system_user \\\n  user='username'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_system_user?api.version=1&user=username","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Validate username availability on target server","operationId":"validate_system_user","description":"This function validates a system user for use on the target server.\n\n**Note:**\n\n  For more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","parameters":[{"schema":{"type":"string","example":"username"},"description":"The system username.","required":"true","in":"query","name":"user"}],"x-cpanel-available-version":"11.44","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"valid_for_transfer":{"type":"integer","enum":["0","1"],"example":"1","description":"Whether the username is valid for a transferred account, but not a new account.\n* `1` — Valid for transfer, but **not** a new account.\n* `0` — Invalid."},"valid_for_new":{"description":"Whether the system can use the username to create a new account.\n* `1` — Usable.\n* `0` — Unusable.","enum":["0","1"],"example":"1","type":"integer"},"exists":{"type":"integer","description":"Whether the username exists on the server.\n* `1` — Exists.\n* `0` — Does **not** exist.","example":"1","enum":["0","1"]},"reserved":{"description":"Whether the username is reserved.\n* `1` — Reserved.\n* `0` — **Not** reserved.","enum":["0","1"],"example":"1","type":"integer"}}},"metadata":{"properties":{"command":{"example":"validate_system_user","description":"The method name called.","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details.","enum":["0","1"],"example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}}}}},"x-tagGroups":[{"tags":["Transfer Configuration"],"name":"Transfers"}],"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"modsec_get_log":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Server Settings","description":"Web Server Security (ModSecurity) / Server Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Server Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_get_log":{"get":{"summary":"Return ModSecurity logs","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_get_log\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_log?api.version=1","label":"URL","lang":"HTTP"}],"tags":["ModSecurity","Server Settings"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"array","description":"An array of objects that contains information about the log entry.","items":{"type":"object","properties":{"id":{"minimum":"1","type":"integer","example":"28","description":"The line number from the `modsec` database."},"http_version":{"type":"string","description":"The HTTP version number.","example":"HTTP/1.1"},"meta_uri":{"type":"string","nullable":"true","format":"uri","description":"The client-requested URI.\n\n**Note:**\n\nThis data is not always available.","example":null},"host":{"type":"string","description":"The virtual host's (vhost) domain name.","example":"server.example.com"},"http_method":{"example":"GET","description":"The\n[HTTP method](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)\nthat the client used to generate the hit.","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.","example":"1","enum":["1","0"],"type":"integer"},"meta_id":{"type":"integer","description":"The ID of the ModSecurity rule that triggered the log entry.","example":"960032"},"http_status":{"type":"integer","example":"406","description":"The\n[HTTP status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)\nthat the web server returned."},"action_desc":{"type":"string","description":"The web server's response to the client.","example":"Access denied with code 406 (phase 1)."},"meta_logdata":{"example":"GET","description":"The transaction data fragment from the ModSecurity rule's logdata action.","nullable":"true","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_offset":{"example":"0","description":"The byte offset at which a match occurred within the target data.\n\n**Note:**\n\nThis data is not always available.","type":"integer"},"handler":{"description":"This parameter **only** returns the `null` value.","example":null,"nullable":"true","type":"string"},"path":{"example":"/favicon.ico","description":"The accessed file's absolute path and filename.","type":"string"},"timestamp":{"example":"2019-10-13T07:58:04","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.","format":"ISO-8601 Date Time","type":"string"},"meta_line":{"type":"integer","minimum":"1","description":"The ModSecurity rule's line number that triggered the log entry.","example":"31"},"meta_severity":{"description":"The hit severity level from the ModSecurity rule's `severity` action.","example":"CRITICAL","nullable":"true","type":"string"},"file_exists":{"type":"integer","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"},"justification":{"example":"Match of \"within %{tx.allowed_methods}\" against \"REQUEST_METHOD\" required.","description":"The specific criteria from the ModSecurity rule that generated the hit.","type":"string"},"meta_rev":{"type":"integer","nullable":"true","example":"2","description":"The revision number from the ModSecurity rule's `rev` action."},"ip":{"type":"string","example":"10.1.14.77","format":"ipv4","description":"The client's IP address."},"meta_msg":{"type":"string","example":"Method is not allowed by policy","description":"The human-readable message from the ModSecurity rule's `msg` action."},"timezone":{"example":"-300","description":"The server's configured timezone, in minutes difference UTC/GMT format.","type":"integer"}}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"modsec_get_log"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.46","parameters":[],"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"}}}},"listzones":{"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"DNS Zones","description":"DNS / DNS Zones"}],"paths":{"/listzones":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"listzones","type":"string"}}},"data":{"type":"object","properties":{"zone":{"items":{"properties":{"zonefile":{"type":"string","example":"example.net.db","description":"The zone file's name."},"domain":{"example":"example.com","description":"The domain name.","format":"domain","type":"string"}},"type":"object"},"description":"An array of objects of zone information.","type":"array"}}}}}}}}},"x-cpanel-available-version":"11","parameters":[],"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","summary":"Return server's DNS zones","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  listzones\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/listzones?api.version=1"}],"tags":["DNS","DNS Zones"]}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Zones"]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"}},"forcepasswordchange":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"name":"Accounts","tags":["Passwords"]}],"paths":{"/forcepasswordchange":{"get":{"description":"This function forces a user to change the account password after the next login attempt.","operationId":"forcepasswordchange","parameters":[{"required":"true","in":"query","name":"users_json","schema":{"type":"string","example":"{\"user1\":1,\"user2\":1,\"user3\":1}","format":"json"},"description":"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."},{"in":"query","name":"stop_on_failure","required":"false","description":"Whether to halt the function if it experiences an error.\n* `1` - Halt on error.\n* `0` - Continue on error.","schema":{"default":"0","example":"1","enum":["0","1"],"type":"integer"}}],"x-cpanel-available-version":"11.32","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"updated":{"type":"array","description":"A list of usernames that the system will force to change their passwords. One or more valid usernames.","items":{"example":"user","type":"string"}}}},"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"- `1` - Success\n- `0` - Failed: Check the reason field for more details."},"command":{"type":"string","example":"forcepasswordchange","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"tags":["Passwords"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  forcepasswordchange \\\n  users_json='{\"user1\":1,\"user2\":1,\"user3\":1}'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/forcepasswordchange?api.version=1&users_json=%7b%22user1%22%3a1%2c%22user2%22%3a1%2c%22user3%22%3a1%7d"}],"x-cpanel-api-version":"WHM API 1","summary":"Enable forced password update"}}},"tags":[{"name":"Passwords","description":"Accounts / Passwords"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}]},"twofactorauth_set_tfa_config_for_user":{"paths":{"/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","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"twofactorauth_set_tfa_config_for_user","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"118","tags":["Authentication","Two-Factor Authentication"],"requestBody":{"content":{"application/json":{"schema":{"example":{"example":{"primary_account":{"secret":"QLLIU5WTY3UTJGNG"},"email":{"user@example.com":{"secret":"QLLIU5WTY3UTJGNG"}},"team":{"team_user@example":{"secret":"QLLIU5WTY3UTJGNG"}}}},"type":"object","additionalProperties":{"type":"object","properties":{"email":{"type":"object","additionalProperties":{"properties":{"secret":{"example":"QLLIU5WTY3UTJGNG","description":"The 2FA secret for the account.","type":"string"}},"type":"object","description":"An object that contains a hash of the email account's data."},"description":"The email data for the user."},"primary_account":{"description":"An object that contains the secret for the cPanel user.","type":"object","properties":{"secret":{"example":"QLLIU5WTY3UTJGNG","description":"The 2FA secret for the account.","type":"string"}}},"team":{"additionalProperties":{"description":"An object that contains a hash of the team user account's data.","type":"object","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}}}}},"description":"The cPanel user account for which to set the 2FA config."}}}},"required":"true"},"x-codeSamples":[{"lang":"Shell","label":"CLI","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"},{"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\"}}}}","label":"HTTP Request (Wire Format)","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Update cPanel account's 2FA data"}}},"x-tagGroups":[{"name":"Authentication","tags":["Two-Factor Authentication"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.117.0.9999","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"unsuspendreseller":{"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"description":"Resellers / Account Management","name":"Reseller Account Management"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Reseller Account Management"],"name":"Resellers"}],"paths":{"/unsuspendreseller":{"get":{"parameters":[{"in":"query","name":"user","required":"true","description":"The reseller's username.","schema":{"example":"username","type":"string"}},{"required":"false","name":"reseller-only","in":"query","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]},"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."}],"description":"This function unsuspends a reseller account.","operationId":"unsuspendreseller","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"unsuspendreseller","description":"The method name called.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  unsuspendreseller \\\n  user='username'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/unsuspendreseller?api.version=1&user=username","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Unsuspend reseller"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"enable_authentication_provider":{"x-tagGroups":[{"tags":["External Authentication"],"name":"Authentication"}],"paths":{"/enable_authentication_provider":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Enable identity provider","tags":["Authentication","External Authentication"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enable_authentication_provider \\\n  service_name='cpaneld' \\\n  provider_id='cpanelid'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_authentication_provider?api.version=1&service_name=cpaneld&provider_id=cpanelid"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"enable_authentication_provider"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"54","parameters":[{"description":"The cPanel & WHM service's name:\n\n* `cpaneld`\n* `webmaild`\n* `whostmgrd`","schema":{"example":"cpaneld","enum":["cpaneld","webmaild","whostmgrd"],"type":"string"},"in":"query","name":"service_name","required":"true"},{"schema":{"example":"cpanelid","type":"string"},"description":"A valid identity provider's identification key.","required":"true","in":"query","name":"provider_id"}],"operationId":"enable_authentication_provider","description":"This function enables an external authentication identity provider for a specified service."}}},"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"Authentication / External Authentication","name":"External Authentication"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2"},"api_token_list":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"API Token Management","description":"API Development Tools / API Token Management"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"API Development Tools","tags":["API Token Management"]}],"paths":{"/api_token_list":{"get":{"x-cpanel-api-version":"WHM API 1","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"api_token_list","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"tokens":{"type":"object","additionalProperties":{"properties":{"expires_at":{"nullable":"true","description":"The API token's expiration time. If the API token does not expire, the value is `null`.","format":"unix_timestamp","example":"1609372800","type":"integer"},"create_time":{"example":"1483625276","format":"unix_timestamp","description":"The API token's creation time.","type":"integer"},"whitelist_ips":{"type":"array","nullable":"true","example":["192.0.2.1","192.0.2.2","192.0.2.8/29","fc00:abcd:0000:0000:0000:0000:0000:000f","2620:0000:28a4:0000:0000:0000:0000:0000/48"],"items":{"anyOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"},{"format":"cidr","type":"string"}]},"description":"List of remote IP or CIDR IP ranges this token may be used from."},"acls":{"additionalProperties":{"type":"integer","example":"1","enum":["0","1"],"description":"Whether the Access Control List (ACL) is enabled.\n* `1` - The ACL is enabled.\n* `0` - The ACL is disabled.\n\n**Note**\n\nThe property name should be an [ACL](https://go.cpanel.net/ACLReferenceChart)."},"description":"An object of privileges available to the user."},"name":{"description":"The API token's name.","example":"my-token-name","type":"string"}},"description":"An object of API token details."},"description":"An object that contains WHM account's API token names.","example":{"my-controller-token":{"whitelist_ips":["192.0.2.1","192.0.2.2","192.0.2.8/29","fc00:abcd:0000:0000:0000:0000:0000:000f","2620:0000:28a4:0000:0000:0000:0000:0000/48"],"acls":{"edit-account":"0","list-accts":"1","create-acct":"0","upgrade-account":"0","limit-bandwidth":"1","suspend-acct":"1"},"name":"my-controller-token","expires_at":"1609372800","create_time":"1483625276"},"my-read-only-token":{"create_time":"1490882281","expires_at":null,"name":"my-read-only-token","whitelist_ips":null,"acls":{"upgrade-account":"0","limit-bandwidth":"0","suspend-acct":"0","edit-account":"0","list-accts":"1","create-acct":"0"}}}}}}}}}},"description":"HTTP Request was successful."}},"summary":"Return WHM API tokens","x-cpanel-available-version":"64","tags":["Authentication","API Token Management"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  api_token_list\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/api_token_list?api.version=1"}],"operationId":"api_token_list","description":"This function lists a WHM account's API tokens."}}}},"modsec_discard_rule_changes":{"paths":{"/modsec_discard_rule_changes":{"get":{"tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  modsec_discard_rule_changes \\\n  config='modsec2.example.conf'\n"},{"lang":"HTTP","label":"URL","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","summary":"Remove staged ModSecurity rule changes","parameters":[{"schema":{"example":"modsec2.example.conf","type":"string"},"description":"The ModSecurity configuration file in the `/usr/local/cpanel/apache/conf/` directory.","required":"true","name":"config","in":"query"}],"operationId":"modsec_discard_rule_changes","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.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{}},"metadata":{"properties":{"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"command":{"example":"modsec_discard_rule_changes","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"11.46"}}},"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"cpsc_get_config":{"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"cPCloud","description":"cPCloud related WHM API 1 functions."}],"paths":{"/cpsc_get_config":{"get":{"summary":"Get the current deployment configuration for a cPCloud Service.","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cpsc_get_config \\\n  service=database\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cpsc_get_config?api.version=1&service=database","label":"URL","lang":"HTTP"}],"tags":["cPCloud"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"A key value object of the requested service configuration.","additionalProperties":{},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"cpsc_get_config","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.112","parameters":[{"schema":{"example":"database","type":"string"},"description":"The name of the service to get the configuration for.","required":"true","in":"query","name":"service"}],"x-cpanel-internal-only":"true","description":"This function obtains the current deployment configuration of a cPCloud Service.","operationId":"cpsc_get_config"}}},"x-tagGroups":[{"tags":["cPCloud"],"name":"cPCloud"}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"version":"11.111.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"restore_queue_activate":{"paths":{"/restore_queue_activate":{"get":{"parameters":[],"operationId":"restore_queue_activate","description":"This function activates the restore queue. This triggers a process that restores all queued accounts.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The 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"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"restore_queue_activate"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.38","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"}],"tags":["Account Restoration","Restore Queue Management"],"summary":"Start restoration","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Account Restoration","tags":["Restore Queue Management"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"name":"Account Restoration","description":"The Account Restoration module for WHM API 1."},{"name":"Restore Queue Management","description":"Account Restoration / Restore Queue Management"}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"rename_postgresql_user":{"paths":{"/rename_postgresql_user":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"description":"The method name called.","example":"rename_postgresql_user","type":"string"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.44","parameters":[{"in":"query","name":"oldname","required":"true","description":"The database user's current name.","schema":{"type":"string","format":"username","example":"username"}},{"in":"query","name":"newname","required":"true","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.","schema":{"type":"string","example":"username2"}},{"schema":{"type":"string","example":"12345luggage"},"description":"The database user's new password.","required":"true","name":"password","in":"query"},{"schema":{"type":"string","example":"example"},"description":"The database user's owner.","required":"false","in":"query","name":"cpuser"}],"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","x-cpanel-api-version":"WHM API 1","summary":"Update PostgreSQL username","tags":["Databases","PostgreSQL Databases"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  rename_postgresql_user \\\n  oldname='username' \\\n  newname='username2' \\\n  password='12345luggage'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_postgresql_user?api.version=1&oldname=username&newname=username2&password=12345luggage"}]}}},"x-tagGroups":[{"name":"Databases","tags":["PostgreSQL Databases"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"PostgreSQL Databases","description":"Databases / PostgreSQL Databases"}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"delete_account_enhancement":{"paths":{"/delete_account_enhancement":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Remove an Account Enhancement","tags":["Account Enhancements"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  delete_account_enhancement \\\n  name='enhancement 5000'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_account_enhancement?api.version=1&name=enhancement%205000","label":"URL","lang":"HTTP"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"delete_account_enhancement","description":"The name of the method called."},"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"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"98","parameters":[{"name":"name","in":"query","required":"true","description":"The name of the account enhancement.","schema":{"example":"enhancement 5000","type":"string"}}],"operationId":"delete_account_enhancement","description":"This function removes an account enhancement."}}},"x-tagGroups":[{"name":"Accounts","tags":["Account Enhancements"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The Account Enhancement module for WHM.","name":"AccountEnhancement"},{"name":"Account Enhancements","description":"Accounts / Account Enhancements"}],"info":{"version":"11.97.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"update_featurelist":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"paths":{"/update_featurelist":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"invalid_features":{"items":{"type":"object","properties":{"invalid feature":{"type":"integer","example":"1","enum":["0","1"],"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."}}},"description":"An array of invalid feature names. This array includes the invalid  feature return.","type":"array"},"featurelist":{"example":"TheBlackLagoon","description":"The feature list's name. A valid string.","type":"string"},"updated_features":{"description":"hash of features in the feature list. This hash includes the feature  name return.","type":"object","properties":{"feature name":{"type":"integer","enum":["0","1"],"example":"1","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."},"autoresponders":{}}}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"update_featurelist","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}}}},"operationId":"update_featurelist","description":"This function creates or updates a feature list.","parameters":[{"schema":{"type":"string","example":"TheBlackLagoon"},"description":"The feature list's name.","required":"true","in":"query","name":"featurelist"},{"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.","schema":{"example":"1","enum":["0","1"],"type":"integer"},"name":"feature name","in":"query","required":"false"}],"x-cpanel-api-version":"WHM API 1","summary":"Update feature list","tags":["Packages","Feature Lists"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_featurelist \\\n  featurelist='TheBlackLagoon'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_featurelist?api.version=1&featurelist=TheBlackLagoon"}]}}},"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Lists"]}]},"delip":{"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/delip":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  delip \\\n  ip='10.1.1.1'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/delip?api.version=1&ip=10.1.1.1"}],"tags":["IP Addresses","IPv4 Address Settings"],"summary":"Remove IP address","x-cpanel-api-version":"WHM API 1","parameters":[{"in":"query","name":"ip","required":"true","description":"The IPv4 address.","schema":{"type":"string","format":"ipv4","example":"10.1.1.1"}},{"required":"false","name":"ethernetdev","in":"query","schema":{"nullable":"true","example":"eth0","default":"","type":"string"},"description":"The network alias to which the IPv4 address is bound."},{"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.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"in":"query","name":"skipifshutdown","required":"false"}],"operationId":"delip","description":"This function removes an IP address from the server.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"delip","description":"The method name called."},"reason":{"description":"The 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"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11"}}},"x-tagGroups":[{"tags":["IPv4 Address Settings"],"name":"IP Address Management"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"name":"IPv4 Address Settings","description":"IP Address Management / IPv4 Address Settings"}]},"disable_market_provider":{"tags":[{"name":"Market","description":"The Market module for WHM API 1."},{"description":"cPanel Market / Provider Management","name":"Provider Management"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Provider Management"],"name":"cPanel Market"}],"paths":{"/disable_market_provider":{"get":{"description":"This function disables a cPanel Market provider.","operationId":"disable_market_provider","parameters":[{"schema":{"type":"string","example":"cPStore"},"description":"The cPanel Market provider's name.","required":"true","in":"query","name":"name"}],"x-cpanel-available-version":"56","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"disable_market_provider"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  disable_market_provider \\\n  name='cPStore'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_market_provider?api.version=1&name=cPStore"}],"tags":["Market","Provider Management"],"summary":"Disable Market provider","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"setminimumpasswordstrengths":{"tags":[{"description":"The Security module for WHM API 1.","name":"Security"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Server Administration","tags":["Security"]}],"paths":{"/setminimumpasswordstrengths":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Update minimum password strength","tags":["Security"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  setminimumpasswordstrengths\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/setminimumpasswordstrengths?api.version=1"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"setminimumpasswordstrengths","type":"string"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the `reason` field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"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":[{"schema":{"maximum":"100","type":"integer","minimum":"1","example":"50"},"description":"The minimum password strength for all services.","required":"false","in":"query","name":"default"},{"schema":{"example":"50","type":"integer","maximum":"100","minimum":"1"},"description":"The minimum password strength for cPAddons.","required":"false","in":"query","name":"cpaddons"},{"required":"false","in":"query","name":"createacct","schema":{"minimum":"1","maximum":"100","type":"integer","example":"50"},"description":"The minimum password strength for new cPanel accounts."},{"schema":{"type":"integer","maximum":"100","minimum":"1","example":"50"},"description":"The minimum password strength for FTP accounts.","required":"false","name":"ftp","in":"query"},{"schema":{"example":"50","minimum":"1","type":"integer","maximum":"100"},"description":"The minimum password strength for mailing lists.","required":"false","name":"list","in":"query"},{"schema":{"type":"integer","maximum":"100","minimum":"1","example":"50"},"description":"The minimum password strength for MySQL® database users.","required":"false","in":"query","name":"mysql"},{"in":"query","name":"passwd","required":"false","description":"The minimum password strength for WHM user or system accounts.","schema":{"example":"50","type":"integer","maximum":"100","minimum":"1"}},{"required":"false","name":"postgres","in":"query","schema":{"maximum":"100","type":"integer","minimum":"1","example":"50"},"description":"The minimum password strength for PostgreSQL® database users."},{"name":"sshkey","in":"query","required":"false","description":"The minimum password strength for SSH keys.","schema":{"example":"50","maximum":"100","type":"integer","minimum":"1"}},{"description":"The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.","schema":{"example":"50","minimum":"1","type":"integer","maximum":"100"},"name":"virtual","in":"query","required":"false"}]}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_autossl_problems_for_user":{"paths":{"/get_autossl_problems_for_user":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_autossl_problems_for_user \\\n  username='username'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_problems_for_user?api.version=1&username=username"}],"tags":["SSL","cPanel Account Settings"],"summary":"Return account DCV issues","x-cpanel-api-version":"WHM API 1","operationId":"get_autossl_problems_for_user","description":"This function returns the list of the latest Domain Control Validation (DCV) problems for a cPanel user.","parameters":[{"schema":{"type":"string","example":"username","format":"username"},"description":"The user for whom to poll the DCV status.","required":"true","in":"query","name":"username"}],"x-cpanel-available-version":"68","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"get_autossl_problems_for_user","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"problems_by_domain":{"type":"array","description":"An array of objects that contain information about DCV problems for each domain.","items":{"properties":{"problem":{"example":"doesnotexist.example.com does not resolve to any IPv4 addresses on the internet.","description":"The human readable explanation of the DCV problem.\n\n**Note**\n\nThe system does **not** localize this return.","type":"string"},"domain":{"example":"doesnotexist.example.com","format":"domain","description":"The domain's name","type":"string"},"log":{"type":"string","example":"2017-09-07T03:51:01.000Z","format":"ISO-8601 Date Time","description":"The log folder of the last run in the `/var/cpanel/logs/autossl/` directory."},"time":{"type":"string","format":"ISO-8601 Date Time","description":"The last run time of the AutoSSL queue.","example":"2017-08-12T21:02:56.000Z"}},"type":"object"}}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}],"servers":[{"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."}},"description":"A server running WHM."}],"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"disable_dkim":{"paths":{"/disable_dkim":{"get":{"summary":"Disable domain's DKIM records","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  disable_dkim \\\n  domain='example.com'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_dkim?api.version=1&domain=example.com"}],"tags":["Mail","Mail DNS Settings"],"x-cpanel-available-version":"78","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"payload":{"type":"array","description":"An array of objects that contains information about the removal of a domain's DKIM record on the DNS server.","items":{"properties":{"domain":{"example":"example.com","description":"The domain for which the system removed the DKIM record.","type":"string"},"msg":{"type":"string","description":"Information about the removed DKIM record.","example":"[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=MIGfMAOGCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB;]"},"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"}}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"command":{"type":"string","description":"The method name called.","example":"disable_dkim"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"}}}},"type":"object"}}}}},"description":"This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.","operationId":"disable_dkim","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string"},"examples":{"multiple":{"value":"domain=example-1.com domain=example-2.com domain=example-3.com","summary":"To remove multiple domain DKIM records"},"single":{"value":"example.com","summary":"To remove a single domain DKIM record"}},"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."}]}}},"x-tagGroups":[{"tags":["Mail DNS Settings"],"name":"Mail"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"name":"Mail DNS Settings","description":"Mail / Mail DNS Settings"}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"setresellernameservers":{"x-tagGroups":[{"name":"Resellers","tags":["Account Settings"]}],"paths":{"/setresellernameservers":{"get":{"summary":"Update reseller's assigned nameservers","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  setresellernameservers \\\n  user='username'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellernameservers?api.version=1&user=username","label":"URL","lang":"HTTP"}],"tags":["Resellers","Account Settings"],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"setresellernameservers"}}}},"type":"object"}}}}},"description":"This function assigns nameservers to a reseller's account.","operationId":"setresellernameservers","parameters":[{"description":"The reseller's username.","schema":{"type":"string","format":"username","example":"username"},"name":"user","in":"query","required":"true"},{"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":{"single":{"summary":"A single nameserver","value":"ns1.example.com"},"multiple":{"value":"ns1.example.com,ns2.example.com","summary":"Multiple nameservers"}},"schema":{"type":"string"},"name":"nameservers","in":"query","required":"false"}]}}},"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"description":"Resellers / Account Settings","name":"Account Settings"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"update_contact_email":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Notifications","name":"Notifications"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Notifications"],"name":"Server Administration"}],"paths":{"/update_contact_email":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_contact_email \\\n  contact_email='user@example.com'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_contact_email?api.version=1&contact_email=user%40example.com"}],"tags":["Server Administration","Notifications"],"summary":"Update WHM contact email address","x-cpanel-api-version":"WHM API 1","description":"This function updates the contact email address in the `wwwacct.conf` file.\nFor more information, read our \n[Installation Guide - Customize Your Installation](https://docs.cpanel.net/installation-guide/customize-your-installation/)\ndocumentation.","operationId":"update_contact_email","parameters":[{"schema":{"type":"string","example":"user@example.com"},"description":"The contact email address to add as the `wwwacct.conf` file's `CONTACTEMAIL`\nsetting.","required":"true","in":"query","name":"contact_email"}],"x-cpanel-available-version":"76","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"description":"The method name called.","example":"update_contact_email","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}}},"backup_destination_validate":{"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/backup_destination_validate":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_destination_validate \\\n  id='0W1ei2rd3A4lI5sT6he7Be8st' \\\n  disableonfail='1'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_validate?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st&disableonfail=1","label":"URL","lang":"HTTP"}],"tags":["Backups","Backup Destination"],"summary":"Validate a backup destination","x-cpanel-api-version":"WHM API 1","operationId":"backup_destination_validate","description":"This function validates a backup destination.","parameters":[{"schema":{"type":"string","example":"0W1ei2rd3A4lI5sT6he7Be8st"},"description":"The destination's ID.","required":"true","name":"id","in":"query"},{"schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether to disable the backup destination if validation fails.\n\n* `1` — Disable.\n* `0` — Do **not** disable.","required":"true","name":"disableonfail","in":"query"}],"x-cpanel-available-version":"11.38","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"backup_destination_validate","type":"string"}}},"data":{"type":"object","properties":{"id":{"description":"The destination's ID.","example":"0W1ei2rd3A4lI5sT6he7Be8st","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"name":"Backups","tags":["Backup Destination"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup Destination","name":"Backup Destination"}]},"listcrts":{"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / SSL Server Settings","name":"SSL Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["SSL Server Settings"],"name":"SSL Certificates"}],"paths":{"/listcrts":{"get":{"operationId":"listcrts","description":"This function lists the server's domains with installed SSL certificates.","parameters":[{"schema":{"type":"integer","default":"0","enum":["1","0"],"example":"1"},"description":"Whether to limit the results to certificates registered with\na certificate authority (CA).\n\n* `1` — Registered certificates **only**.\n* `0` — All certificates.","required":"false","in":"query","name":"registered"},{"in":"query","name":"user","required":"false","description":"The cPanel username.\n\nIf you do **not** use this parameter, the function returns certificates\nfor **all** accounts on the server.","schema":{"format":"username","example":"username","type":"string"}}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"command":{"example":"listcrts","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"}}},"data":{"type":"object","properties":{"crt":{"description":"Information about the certificate.","items":{"type":"object","properties":{"domains":{"type":"array","example":["example.com"],"description":"A list of the domain or domains that the certificate covers.","items":{"type":"string","format":"domain"}},"domain_owners":{"type":"array","example":["username"],"items":{"type":"string","format":"username"},"description":"A list of the owners of the domain or domains that the certificate covers."},"issuer.organizationName":{"description":"The certificate's Organization Name.","example":"Organization","type":"string"},"key_algorithm":{"type":"string","example":"rsaEncryption","enum":["rsaEncryption","id-ecPublicKey"],"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA."},"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"},"signature_algorithm":{"type":"string","example":"sha256WithRSAEncryption","description":"The certificate's OID hash algorithm signature."},"validation_type":{"enum":["ev","dv","ov"],"example":"dv","description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validated.\n* `null` — The system could **not** parse and determine the\ncertificate's validation type.","nullable":"true","type":"string"},"domain":{"type":"string","description":"The certificate's primary domain.","format":"domain","example":"example.com"},"friendly_name":{"type":"string","example":"TestCertificate","description":"The certificate's friendly name."},"not_after":{"type":"integer","format":"unix_timestamp","description":"The date the certificate expires.","example":"1601467200"},"registered":{"type":"integer","description":"Whether the certificate is registered with a CA.\n\n* `1` — Registered.\n* `0` — **Not** registered.","enum":["1","0"],"example":"1"},"modulus_length":{"type":"integer","example":"2048","description":"The certificate's key's modulus length, in bits.\n\n* `null` — The certificate's key is **not** an RSA key.","nullable":"true"},"id":{"description":"The certificate's ID.","example":"example._com_d13b4_362b9_1400343187_b05e5c3e443dda9a8869c4cf7457829e","type":"string"},"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.","example":null,"enum":["prime256v1","secp384r1"],"nullable":"true","type":"string"}}},"type":"array"}}}},"type":"object"}}}}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  listcrts\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/listcrts?api.version=1"}],"tags":["SSL","SSL Server Settings"],"summary":"Return domains with installed SSL certificates","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"setacls":{"x-tagGroups":[{"name":"Resellers","tags":["Account Permissions"]}],"paths":{"/setacls":{"get":{"parameters":[{"required":"true","in":"query","name":"reseller","schema":{"type":"string","example":"username","format":"username"},"description":"The reseller's username."},{"required":"false","name":"user","in":"query","schema":{"type":"string","example":"username","format":"username"},"description":"The reseller's username.\n\n**Note:**\n\nThis parameter is an alias for `reseller` and is provided for backwards compatibility."},{"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.","schema":{"example":"my_acl_list","type":"string"},"name":"acllist","in":"query","required":"false"},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to edit hosting plans (packages).","required":"false","name":"acl-edit-pkg","in":"query"},{"schema":{"example":"1","enum":["1"],"type":"integer"},"description":"Whether to allow the reseller to add and remove hosting plans (packages).","required":"false","in":"query","name":"acl-add-pkg"},{"in":"query","name":"acl-list-pkgs","required":"false","description":"Whether to allow the reseller to view existing hosting plans (packages).","schema":{"example":"1","enum":["1"],"type":"integer"}},{"description":"Whether to allow the reseller to troubleshoot mail delivery.","schema":{"type":"integer","example":"1","enum":["1"]},"name":"acl-mailcheck","in":"query","required":"false"},{"schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to generate a mobile configuration profile for an email account.","required":"false","name":"acl-generate-email-config","in":"query"},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to view account bandwidth usage.","required":"false","in":"query","name":"acl-show-bandwidth"},{"description":"Whether to allow the reseller to view the list of accounts.","schema":{"enum":["1"],"example":"1","type":"integer"},"name":"acl-list-accts","in":"query","required":"false"},{"description":"Whether to allow the reseller to view an account summary.","schema":{"enum":["1"],"example":"1","type":"integer"},"in":"query","name":"acl-acct-summary","required":"false"},{"schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to use DNS clusters.","required":"false","in":"query","name":"acl-clustering"},{"required":"false","name":"acl-news","in":"query","schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to modify the server's news."},{"description":"Whether to allow the reseller to manage third-party services.","schema":{"type":"integer","example":"1","enum":["1"]},"in":"query","name":"acl-thirdparty","required":"false"},{"required":"false","in":"query","name":"acl-kill-dns","schema":{"example":"1","enum":["1"],"type":"integer"},"description":"Whether to allow the reseller to remove DNS zones."},{"description":"Whether to allow the reseller to edit DNS zones.","schema":{"enum":["1"],"example":"1","type":"integer"},"in":"query","name":"acl-edit-dns","required":"false"},{"name":"acl-cpanel-api","in":"query","required":"false","description":"Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.","schema":{"example":"1","enum":["1"],"type":"integer"}},{"required":"false","name":"acl-park-dns","in":"query","schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to park DNS zones."},{"required":"false","in":"query","name":"acl-create-dns","schema":{"type":"integer","example":"1","enum":["1"]},"description":"Whether to allow the reseller to add DNS zones."},{"name":"acl-manage-api-tokens","in":"query","required":"false","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.","schema":{"type":"integer","enum":["1"],"example":"1"}},{"required":"false","name":"acl-manage-oidc","in":"query","schema":{"type":"integer","example":"1","enum":["1"]},"description":"Whether to allow the reseller to manage external authentication for their accounts."},{"schema":{"example":"1","enum":["1"],"type":"integer"},"description":"Whether to allow the reseller to manage DNS records.","required":"false","name":"acl-manage-dns-records","in":"query"},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to manage their server's cPanel styles.","required":"false","in":"query","name":"acl-manage-styles"},{"description":"Whether to allow the reseller to manage nameservers.","schema":{"example":"1","enum":["1"],"type":"integer"},"name":"acl-nameserver-config","in":"query","required":"false"},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to perform SSL site management.","required":"false","name":"acl-ssl","in":"query"},{"required":"false","name":"acl-ssl-info","in":"query","schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to view their server's SSL information."},{"in":"query","name":"acl-mysql-info","required":"false","description":"Whether to allow the reseller to retrieve MySQL® database and user data.","schema":{"example":"1","enum":["1"],"type":"integer"}},{"schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to create accounts.","required":"false","in":"query","name":"acl-create-acct"},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to suspend or unsuspend accounts.","required":"false","in":"query","name":"acl-suspend-acct"},{"name":"acl-basic-system-info","in":"query","required":"false","description":"Whether to allow the reseller to retrieve basic system information.","schema":{"type":"integer","example":"1","enum":["1"]}},{"description":"Whether to allow the reseller to access basic cPanel & WHM options.","schema":{"type":"integer","example":"1","enum":["1"]},"in":"query","name":"acl-basic-whm-functions","required":"false"},{"schema":{"type":"integer","example":"1","enum":["1"]},"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.","required":"false","name":"acl-passwd","in":"query"},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to purchase SSL certificates.","required":"false","name":"acl-ssl-buy","in":"query"},{"required":"false","in":"query","name":"acl-cpanel-integration","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."},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.","required":"false","name":"acl-cors-proxy-get","in":"query"},{"required":"false","name":"acl-upgrade-account","in":"query","schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to upgrade or downgrade accounts."},{"in":"query","name":"acl-ssl-gencrt","required":"false","description":"Whether to allow the reseller to generate SSL certificates.","schema":{"type":"integer","enum":["1"],"example":"1"}},{"in":"query","name":"acl-create-user-session","required":"false","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.","schema":{"type":"integer","example":"1","enum":["1"]}},{"required":"false","name":"acl-edit-mx","in":"query","schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to edit MX entries."},{"description":"Whether to allow the reseller to manage Digest Authentication support.","schema":{"type":"integer","example":"1","enum":["1"]},"in":"query","name":"acl-digest-auth","required":"false"},{"description":"Whether to allow the reseller to terminate accounts.","schema":{"example":"1","enum":["1"],"type":"integer"},"name":"acl-kill-acct","in":"query","required":"false"},{"name":"acl-viewglobalpackages","in":"query","required":"false","description":"Whether to allow the reseller to use all global packages. For more information, read our [reseller packages](https://go.cpanel.net/resellerpackages) documentation.","schema":{"enum":["1"],"example":"1","type":"integer"}},{"in":"query","name":"acl-disallow-shell","required":"false","description":"Whether to allow the reseller to create accounts with shell access.","schema":{"type":"integer","enum":["1"],"example":"1"}},{"description":"Whether to allow the reseller to create packages with shell access.","schema":{"type":"integer","enum":["1"],"example":"1"},"name":"acl-add-pkg-shell","in":"query","required":"false"},{"in":"query","name":"acl-allow-addoncreate","required":"false","description":"Whether to allow the reseller to create packages with addon domains.","schema":{"enum":["1"],"example":"1","type":"integer"}},{"description":"Whether to allow the reseller to create packages with parked domains (aliases).","schema":{"type":"integer","example":"1","enum":["1"]},"name":"acl-allow-parkedcreate","in":"query","required":"false"},{"schema":{"example":"1","enum":["1"],"type":"integer"},"description":"Whether to allow the reseller to create packages with unlimited disk space.","required":"false","name":"acl-allow-unlimited-disk-pkgs","in":"query"},{"required":"false","in":"query","name":"acl-allow-unlimited-pkgs","schema":{"example":"1","enum":["1"],"type":"integer"},"description":"Whether to allow the reseller to create packages with unlimited features."},{"description":"Whether to allow the reseller to create packages with unlimited bandwidth.","schema":{"enum":["1"],"example":"1","type":"integer"},"name":"acl-allow-unlimited-bw-pkgs","in":"query","required":"false"},{"name":"acl-add-pkg-ip","in":"query","required":"false","description":"Whether to allow the reseller to create packages with a dedicated IP address.","schema":{"type":"integer","enum":["1"],"example":"1"}},{"schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to create and modify locales on the server.","required":"false","in":"query","name":"acl-locale-edit"},{"schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to resync FTP passwords.","required":"false","in":"query","name":"acl-resftp"},{"required":"false","name":"acl-restart","in":"query","schema":{"enum":["1"],"example":"1","type":"integer"},"description":"Whether to allow the reseller to restart services."},{"description":"Whether to allow the reseller to view the server's status.","schema":{"example":"1","enum":["1"],"type":"integer"},"name":"acl-status","in":"query","required":"false"},{"in":"query","name":"acl-stats","required":"false","description":"Whether to allow the reseller to view server information.","schema":{"type":"integer","enum":["1"],"example":"1"}},{"name":"acl-quota","in":"query","required":"false","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.","schema":{"enum":["1"],"example":"1","type":"integer"}},{"in":"query","name":"acl-demo-setup","required":"false","description":"Whether to allow the reseller to enable demo mode for accounts.","schema":{"enum":["1"],"example":"1","type":"integer"}},{"name":"acl-edit-account","in":"query","required":"false","description":"Whether to allow the reseller to edit accounts.","schema":{"type":"integer","enum":["1"],"example":"1"}},{"schema":{"type":"integer","enum":["1"],"example":"1"},"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.","required":"false","name":"acl-limit-bandwidth","in":"query"},{"description":"Whether to allow the reseller to rearrange accounts.","schema":{"example":"1","enum":["1"],"type":"integer"},"name":"acl-rearrange-accts","in":"query","required":"false"},{"required":"false","in":"query","name":"acl-track-email","schema":{"type":"integer","enum":["1"],"example":"1"},"description":"Whether to allow the reseller to view reports about email message delivery attempts from their account."},{"in":"query","name":"acl-all","required":"false","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.","schema":{"enum":["1"],"example":"1","type":"integer"}}],"operationId":"setacls","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* ).","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","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"}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"setacls","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"11","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"},{"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","label":"URL","lang":"HTTP"}],"tags":["Resellers","Account Permissions"],"summary":"Create or update reseller privilege settings","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"Resellers / Account Permissions","name":"Account Permissions"},{"name":"Resellers","description":"The Resellers module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"get_best_ssldomain_for_service":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}],"paths":{"/get_best_ssldomain_for_service":{"get":{"tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_best_ssldomain_for_service \\\n  service='whostmgr'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_best_ssldomain_for_service?api.version=1&service=whostmgr"}],"x-cpanel-api-version":"WHM API 1","summary":"Return SSL-encrypted domain for service access","operationId":"get_best_ssldomain_for_service","description":"This function retrieves the most appropriate SSL-encrypted domain to use to access a service.","parameters":[{"required":"true","in":"query","name":"service","schema":{"example":"whostmgr","type":"string"},"description":"The service's name."}],"x-cpanel-available-version":"56","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"get_best_ssldomain_for_service"},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"}}},"data":{"type":"object","properties":{"is_self_signed":{"type":"integer","description":"Whether the certificate is self-signed.\n\n* `1` — The certificate is self-signed.\n* `0` — The certificate is **not** self-signed.\n\n**Note:**\n\nFor legacy reasons, if the `ssldomain_matches_cert` value is `0`, then the function will **always** return a value\nof `1` for the `is_self_signed return` return, regardless of whether the certificate is actually self-signed.","example":"1","enum":["0","1"]},"ssldomain_matches_cert":{"type":"integer","description":"Whether an SSL-encrypted domain matches the certificate.\n* `1` — Matches.\n* `0` — Does **not** match.","enum":["0","1"],"example":"0"},"cert_match_method":{"type":"string","example":"none","enum":["none","exact","exact-wildcard","mail-wildcard","www-wildcard","hostname-wildcard","hostname","localdomain_on_cert-mail-wildcard","localdomain_on_cert-www-wildcard","localdomain_on_cert"],"description":"The method that the system used to match the domain with the certificate.\n* `none` — No domain matches the certificate.\n* `exact` — The domain exactly matches the certificate.\n* `exact-wildcard` — The domain exactly matches the domain of a wildcard certificate.\n* `mail-wildcard` — The mail subdomain of the domain matches the domain of the wildcard certificate.\n* `www-wildcard` — The `www` subdomain of the domain matches the domain of the wildcard certificate.\n* `hostname-wildcard` — The hostname's domain matches the domain of the wildcard certificate.\n* `hostname` — The hostname matches the domain of the certificate.\n* `localdomain_on_cert-mail-wildcard` — Any `mail` subdomain of any domain on the server matches the certificate.\n* `localdomain_on_cert-www-wildcard` — Any `www` subdomain of any domain on the server matches the certificate.\n* `localdomain_on_cert` — Any domain on the server matches the certificate."},"is_wild_card":{"description":"Whether the service uses a wildcard certificate.\n* `1` — The service uses a wildcard certificate.\n* `0` — The service does **not** use a wildcard certificate.","enum":["0","1"],"example":"0","type":"integer"},"cert_valid_not_after":{"format":"unix_timestamp","description":"The expiration date of the certificate.","example":"1457452989","type":"integer"},"is_currently_valid":{"enum":["0","1"],"example":"0","description":"Whether the certificate is currently valid.\n\n* `1` — The certificate is valid.\n* `0` — The certificate is **not** valid.\n\n**Note:**\n\nIf the certificate is valid, the following statements are true:\n\n* The certificate is **not** self-signed (the `is_self_signed` value is `0`).\n* The certificate matches the SSL domain (the `ssldomain_matches_cert` value is `1`).\n* The certificate is within its validity period (the `cert_valid_not_after` value is less than the current time and date).","type":"integer"},"ssldomain":{"description":"The domain of the service's SSL certificate.","format":"domain","example":"hostname.example.com","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}}},"servicestatus":{"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"x-tagGroups":[{"tags":["Services"],"name":"Server Administration"}],"paths":{"/servicestatus":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"service":{"items":{"type":"object","properties":{"enabled":{"type":"integer","description":"Whether the service is enabled.\n* `1` - Enabled.\n* `0` - Disabled. If a server profile **disables** a service, this returns a `0` value.","example":"1","enum":["0","1"]},"monitored":{"description":"Whether the server monitors the service.\n* `1` - Monitored.\n* `0` - Not monitored. If a server profile **disables** a service, this returns a `0` value.","enum":["0","1"],"example":"1","type":"integer"},"running":{"description":"Whether the service currently runs on the server.\n\n**Note:**\n\nThe function does **not** return this parameter if the server does **not** monitor the service.\n\n* `1` - Running.\n* `0` - Not running.","enum":["0","1"],"example":"1","type":"integer"},"name":{"example":"crond","description":"The service's short name.\n* apache_php_fpm\n* clamd\n* cpanel-dovecot-solr\n* cpanel_php_fpm\n* cpanellogd\n* cpdavd\n* cpgreylistd\n* cphulkd\n* cpsrvd\n* crond\n* dnsadmin\n* exim\n* exim-altport\n* ftpd\n* httpd\n* imap\n* ipaliases\n* lmtp\n* mailman\n* mysql\n* named\n* nscd\n* p0f\n* pop\n* postgresql\n* queueprocd\n* rsyslogd\n* spamd\n* sshd\n* syslogd\n* tailwatchd\n\n**Note:**  For more information about these services, read our [Service Manager](https://go.cpanel.net/whmdocsServiceManager) documentation.","type":"string"},"display_name":{"type":"string","description":"The service's full name.","example":"Cron Daemon"},"installed":{"type":"integer","description":"Whether the service is installed.\n* `1` - Installed.\n* `0` - Uninstalled. If a server profile **disables** a service, this returns a `0` value.","example":"1","enum":["0","1"]}}},"description":"An object containing service information.\n\n**Note:**\n\nCertain [server profiles](https://go.cpanel.net/howtouseserverprofiles) **disable** specific services. For example, the Mail profile's `ftpd` service would return a `0` value for the `enabled`, `installed`, and `monitored` returns.","type":"array","properties":{}}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"example":"servicestatus","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}},"type":"object"}}}}},"description":"This function reports which services (daemons) are enabled, installed, and monitored on your server.","operationId":"servicestatus","parameters":[{"description":"The service for which to view the status.\n\n**Notes**\n\nIf you do **not** specify this parameter, the function will return the status for all of your server's services.\n\nAvailable Services:\n\n* apache_php_fpm\n* clamd\n* cpanel-dovecot-solr\n* cpanel_php_fpm\n* cpanellogd\n* cpdavd\n* cpgreylistd\n* cphulkd\n* cpsrvd\n* crond\n* dnsadmin\n* exim\n* exim-altport\n* ftpd\n* httpd\n* imap\n* ipaliases\n* lmtp\n* mailman\n* mysql\n* named\n* nscd\n* p0f\n* pop\n* postgresql\n* queueprocd\n* rsyslogd\n* spamd\n* sshd\n* syslogd\n* tailwatchd\n\nFor more information about these services, read our [Service Manager](https://go.cpanel.net/whmdocsServiceManager) documentation.","schema":{"type":"string","example":"crond"},"in":"query","name":"service","required":"false"}],"x-cpanel-api-version":"WHM API 1","summary":"Return service status","tags":["Server Administration","Services"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  servicestatus\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/servicestatus?api.version=1"}]}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Services","name":"Services"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}]},"get_autossl_log":{"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"Auto-Generated Certificates","description":"SSL Certificates / Auto-Generated Certificates"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"SSL Certificates","tags":["Auto-Generated Certificates"]}],"paths":{"/get_autossl_log":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return AutoSSL log file's contents","tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  get_autossl_log \\\n  start_time='2016-06-09T14:25:37Z'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_log?api.version=1&start_time=2016-06-09T14%3a25%3a37Z"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"example":"get_autossl_log","description":"The method name called.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1","type":"integer"}}},"data":{"type":"object","properties":{"payload":{"type":"array","items":{"type":"object","properties":{"pid":{"minimum":"1","type":"integer","example":"29189","description":"The AutoSSL process’s ID."},"type":{"type":"string","enum":["out","warn","success","failure"],"example":"out","description":"The type of log file entry.\n\n* `out` (WHM's _Manage AutoSSL_ interface represents this type as `info`.)\n* `warn`\n* `success`\n* `failure`"},"partial":{"type":"integer","description":"We do not currently use this return.","enum":["0"],"example":"0"},"contents":{"type":"string","example":"This system has AutoSSL set to use cPanel (powered by Sectigo).","description":"The contents of an entry."},"indent":{"minimum":"0","type":"integer","example":"0","description":"The level of indentation to display."},"timestamp":{"description":"When the system created the log file entry.","format":"ISO-8601 Date Time","example":"2016-06-09T14:25:37Z","type":"string"}}},"description":"Entries from an AutoSSL log."}}}},"type":"object"}}}}},"x-cpanel-available-version":"58","parameters":[{"required":"true","name":"start_time","in":"query","schema":{"format":"ISO-8601 Date Time","example":"2016-06-09T14:25:37Z","type":"string"},"description":"When the system created the log file."}],"description":"This function returns the contents of an AutoSSL log file.","operationId":"get_autossl_log"}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."}},"start_background_mysql_upgrade":{"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"Manage MySQL Server","description":"Databases / Manage MySQL Server"}],"paths":{"/start_background_mysql_upgrade":{"get":{"description":"This function upgrades MySQL® or MariaDB® in the background. This will reinstall MySQL® or MariaDB® if the version given is the installed version.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) and remote MySQL® is **not** already configured, the system **disables** this function.","operationId":"start_background_mysql_upgrade","parameters":[{"description":"The desired MySQL® or MariaDB® version. Must contain one decimal.","schema":{"example":"5.7","type":"number"},"name":"version","in":"query","required":"true"}],"x-cpanel-available-version":"cPanel 11.48","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"example":"start_background_mysql_upgrade","description":"The method name called.","type":"string"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}},"data":{"type":"object","properties":{"upgrade_id":{"example":"mysql_upgrade.20200202-172923","description":"The upgrade log's location, relative to the `/var/cpanel/logs/` directory.","type":"string"}}}}}}}}},"tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  start_background_mysql_upgrade \\\n  version='5.7'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/start_background_mysql_upgrade?api.version=1&version=5.7"}],"x-cpanel-api-version":"WHM API 1","summary":"Start background MySQL upgrade"}}},"x-tagGroups":[{"name":"Databases","tags":["Manage MySQL Server"]}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}]},"fetch_ssl_certificates_for_fqdns":{"paths":{"/fetch_ssl_certificates_for_fqdns":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  fetch_ssl_certificates_for_fqdns \\\n  domains='example.com'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_ssl_certificates_for_fqdns?api.version=1&domains=example.com"}],"tags":["SSL","cPanel Account Settings"],"summary":"Return cPanel account FQDN certificate information","x-cpanel-api-version":"WHM API 1","description":"This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.","operationId":"fetch_ssl_certificates_for_fqdns","parameters":[{"examples":{"single":{"value":"example.com","summary":"Fetch information for a single domain."},"multiple":{"value":"domains=example-1.com,example-2.com,example-3.com","summary":"Fetch information for multiple domains."}},"description":"A comma-separated list of domains for which to retrieve information.\n\n**Note:**\n\nFor browser-based calls, you **must** URI-encode each comma (`%2C`).","schema":{"format":"domain","type":"string"},"in":"query","name":"domains","required":"true"}],"x-cpanel-available-version":"66","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payload":{"description":"Information about the certificate.","items":{"properties":{"friendly_name":{"type":"string","example":"example.com","description":"The certificate's friendly name."},"validation_type":{"type":"string","description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validated.\n* `dv` — Domain Validated.\n* `null` — The system could **not** parse and determine the\ncertificate's validation type.","example":"dv","enum":["ev","ov","dv"],"nullable":"true"},"issuer.commonName":{"type":"string","description":"The certificate's Common Name.","example":"example.servername.com"},"ecdsa_public":{"type":"string","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"},"not_before":{"description":"The date the certificate started.","format":"unix_timestamp","example":"1538308800","type":"integer"},"signature_algorithm":{"description":"The certificate's OID hash algorithm signature.","example":"sha256WithRSAEncryption","type":"string"},"ecdsa_curve_name":{"example":null,"enum":["prime256v1","secp384r1"],"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.","nullable":"true","type":"string"},"crt":{"type":"string","format":"pem-certificate","description":"The certificate's contents.","example":"-----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-----"},"modulus":{"type":"string","description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"ab4c2a3cc30ff10e918915dee7b5171318373de000774d31c4546bea93303d9b56ae4728615d247c7119ee72660fa05d527b97ac3a936f5cfbf027aa505b79f9942d8c6b79e428cf15a5241db344ad99b697c6ca07ab239c44d9ede7b8017c7f99a7ff8e1819d28e123004b987cecd3a8179ca0fd8d2d9ee9dca6efd1cb3797cc92f1cb4327d163069b6c39b17487e25e286862e8ac65b20d47d03e3c00c1c42c562f7b159ef312546bbbffe327fb6a8a354b10bbf5016b9d264b999c92662960af913e98a48201f145706d382716e67ce94b3661f7b5ee931ab4054957c3006d1ca6dd9e2b996999af5c6b4dda12f8b4b0cf89027df058e69b03469fd646a01","nullable":"true"},"modulus_length":{"type":"integer","example":"2048","description":"The certificate's key's modulus length.\n\n* `null` — The certificate's key is **not** an RSA key.","nullable":"true"},"verify_error":{"description":"An error message that explains the reason for a verification error.","example":"DEPTH_ZERO_SELF_SIGNED_CERT","type":"string"},"id":{"type":"string","description":"The certificate's identification.","example":"example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc"},"not_after":{"example":"1569844800","format":"unix_timestamp","description":"The date the certificate expired.","type":"integer"},"is_self_signed":{"type":"integer","enum":["1","0"],"example":"0","description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — **Not** self-signed."},"key":{"description":"The private key's text.","format":"pem-private-key","example":"-----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-----","type":"string"},"key_algorithm":{"enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","type":"string"},"subject.commonName":{"type":"string","example":"example.com","description":"The certificate's Common Name."},"cab":{"description":"The CA bundle's contents.","format":"pem-certificate","example":"-----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-----","nullable":"true","type":"string"},"users":{"items":{"type":"string","format":"username"},"description":"A list of cPanel account owners.","example":["username"],"type":"array"},"domains":{"type":"array","example":["example.servername.com","example.com","mail.example.com","www.example.com","www.example.servername.com"],"items":{"type":"string","format":"domain"},"description":"The domains that the CSR covers."},"created":{"format":"unix_timestamp","description":"The date the certificate was created.","example":"1538308800","type":"integer"},"issuer.organizationName":{"type":"string","description":"The certificate's Organization Name.","example":"Organization"}}},"type":"array"}}},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"example":"fetch_ssl_certificates_for_fqdns","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"}}}}}}}}}}}},"x-tagGroups":[{"tags":["cPanel Account Settings"],"name":"SSL Certificates"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"enable_cpgreylist":{"paths":{"/enable_cpgreylist":{"get":{"summary":"Enable Greylisting","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  enable_cpgreylist\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_cpgreylist?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Greylisting","Spam Protection (Greylisting)"],"x-cpanel-available-version":"11.50","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"example":"enable_cpgreylist","description":"The method name called.","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"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"}}}}}}},"description":"HTTP Request was successful."}},"operationId":"enable_cpgreylist","description":"This function enables Greylisting.","parameters":[]}}},"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"name":"Spam Protection (Greylisting)","description":"Mail / Spam Protection (Greylisting)"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2"},"get_pkgacct_session_state":{"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API."},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}],"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Backups","tags":["Backup or Restore"]}],"paths":{"/get_pkgacct_session_state":{"get":{"x-cpanel-available-version":"88","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"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":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"get_pkgacct_session_state","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}},"data":{"type":"object","properties":{"state":{"type":"string","description":"The `start_background_pkgacct` session's state.\n* `COMPLETED`\n* `FAILED`\n* `RUNNING`","enum":["COMPLETED","FAILED","RUNNING"],"example":"COMPLETED"}}}},"type":"object"}}}}},"operationId":"get_pkgacct_session_state","description":"This function returns the state of a `start_background_pkgacct` session.","parameters":[{"description":"The `start_background_pkgacct` session ID.","schema":{"type":"string","example":"username20200323154328kDJ2Kx4xua2KtG"},"in":"query","name":"session_id","required":"true"}],"summary":"Return start_background_pkgacct session state","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Backups","Backup or Restore"]}}}},"cpgreylist_is_server_netblock_trusted":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"tags":[{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"description":"Mail / Spam Protection (Greylisting)","name":"Spam Protection (Greylisting)"}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Spam Protection (Greylisting)"],"name":"Mail"}],"paths":{"/cpgreylist_is_server_netblock_trusted":{"get":{"operationId":"cpgreylist_is_server_netblock_trusted","description":"This function returns the Greylisting trusted status of the server's netblock.","parameters":[],"x-cpanel-available-version":"11.50","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"ip_blocks":{"additionalProperties":{"enum":["1","0"],"description":"Whether the *Trusted Hosts* list includes the IP address range.\nThis return's name is the IP address range.\n\n* `1` — Trusted.\n* `0` — Not trusted.","type":"integer"},"type":"object","example":{"199.0.0.0-199.3.255.255":"1","48.0.0.0-48.255.255.255":"1","10.0.0.0-10.255.255.255":"1"},"description":"A list containing the neighboring netblocks."}}},"metadata":{"properties":{"command":{"example":"cpgreylist_is_server_netblock_trusted","description":"The method name called.","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}}}},"tags":["Greylisting","Spam Protection (Greylisting)"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  cpgreylist_is_server_netblock_trusted\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_is_server_netblock_trusted?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return Greylisting trust status of server netblock"}}}},"get_user_email_forward_destination":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"}],"paths":{"/get_user_email_forward_destination":{"get":{"tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_user_email_forward_destination \\\n  user='root'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_user_email_forward_destination?api.version=1&user=root","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel account forward destination","operationId":"get_user_email_forward_destination","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.","parameters":[{"description":"The system account name.","schema":{"type":"string","example":"root"},"in":"query","name":"user","required":"true"}],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"command":{"description":"The method name called.","example":"get_user_email_forward_destination","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"forward_to":{"type":"array","items":{"example":"user@example.com","type":"string"},"description":"The system accounts or email addresses to which the system forwards the account's email."}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["cPanel Account Mail Management"],"name":"Mail"}]},"ticket_list":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM."}],"tags":[{"name":"Support Tickets","description":"The Support Tickets module for WHM API 1."},{"description":"cPanel Support Tickets / Ticket Management","name":"Ticket Management"}],"paths":{"/ticket_list":{"get":{"summary":"Return Support ticket status","x-cpanel-cli-support":"false","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"https://hostname.example.com:2087/cpsess##########/json-api/ticket_list?api.version=1&ticket_id=999999999&server_num=2","label":"URL","lang":"HTTP"}],"tags":["Support Tickets","Ticket Management"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"auths":{"description":"An array of objects containing the ticket authorization information.","items":{"type":"object","properties":{"ticket_status":{"description":"The ticket's status.\n\n* `OPEN`\n* `CLOSED`\n* `UNKNOWN`","enum":["OPEN","CLOSED","UNKNOWN"],"example":"OPEN","type":"string"},"ticket_subject":{"type":"string","description":"The ticket's subject line.","example":"Example ticket"},"ticket_id":{"type":"integer","minimum":"1","example":"999999999","description":"The ticket's ID number."},"servers":{"description":"An array of objects containing the server information.","items":{"properties":{"ssh_username":{"type":"string","example":"username","description":"The username for incoming SSH connections before they escalate to the `root` user."},"auth_time":{"type":"integer","description":"When the grant happened, in\n[Unix time format](http://en.wikipedia.org/wiki/Unix_time).","format":"unit_timestamp","example":"1400603208"},"whm_ip":{"type":"string","example":"10.11.12.13","description":"The server's IP address for WHM connections."},"server_num":{"type":"integer","minimum":"1","description":"The server's ID number.","example":"2"},"server_name":{"type":"string","description":"The server's human-readable description, from the\n[cPanel Customer Portal](https://tickets.cpanel.net/).","example":"My Server"},"auth_status":{"description":"The installation status.\n\n* `AUTHED`\n* `NOT_AUTHED`\n* `EXPIRED`","enum":["AUTHED","NOT_AUTHED","EXPIRED"],"example":"AUTHED","type":"string"},"ssh":{"type":"string","description":"The server's IP address and port number for SSH connections.","example":"10.11.12.13:22"}},"type":"object"}}}}},"non_fatals":{"example":[],"items":{"type":"string"},"description":"Any non-fatal errors.\n\n* `ticket_system_log_entry` — The function could not record the grant\noperation in the ticket.\n* `audit_log` — The function could not record the grant operation in the\nlocal audit log.\n\n**Note:**\n\nThe system stores the local audit log in the\n`/var/cpanel/logs/supportauth/audit.log` file.","type":"array"}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","example":"ticket_list","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.44","parameters":[{"schema":{"type":"integer","minimum":"1","example":"999999999"},"description":"The ticket's ID number.","required":"true","name":"ticket_id","in":"query"},{"required":"true","in":"query","name":"server_num","schema":{"type":"integer","minimum":"1","example":"2"},"description":"The server's ID number."},{"required":"false","name":"ssh_username","in":"query","schema":{"example":"username","type":"string"},"description":"The username for incoming SSH connections before they escalate to the `root` user. If you do not specify a value, the function will select the user from the ticket."}],"operationId":"ticket_list","description":"This function lists all active and open support tickets from the\n[cPanel Customer Portal](https://tickets.cpanel.net/).\n\n**Note:**\n\nThis function is **not** available through the command line. You **must** call\nit as a request body."}}},"x-tagGroups":[{"tags":["Ticket Management"],"name":"cPanel Support Tickets"}]},"convert_addon_get_conversion_status":{"tags":[{"name":"Domain Information","description":"Accounts / Domain Domain Information"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"paths":{"/convert_addon_get_conversion_status":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return conversion status for additional domain","tags":["Domain Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  convert_addon_get_conversion_status \\\n  job_id='10'\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_get_conversion_status?api.version=1&job_id=10"}],"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"properties":{"job_id":{"minimum":"1","pattern":"[1-9]+","type":"string","description":"The conversion's job identification number.\n\n**Note:**\n\nThe system stores this numeric value as a string."},"job_status":{"type":"string","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"]},"job_end_time":{"description":"The time when the convert addon domain to account process ended.","format":"unix_timestamp","type":"integer"},"source_acct":{"description":"The addon domain to convert into a cPanel account.","type":"string"}},"type":"object","description":"The converion job's identification number.\n\n**Note:**\n\nThe property name is the identification number of the requested job."},"type":"object","description":"An object that contains details about the conversion job's status.","example":{"1":{"job_id":"1","job_end_time":"1462383658","job_status":"DONE","source_acct":"user1"}}},"metadata":{"properties":{"reason":{"type":"string","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"},"result":{"enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"convert_addon_get_conversion_status"},"version":{"description":"The API version of the function.","example":"1","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"58","parameters":[{"schema":{"minimum":"1","type":"integer"},"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"}},"required":"true","name":"job_id","in":"query"}],"operationId":"convert_addon_get_conversion_status","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."}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"delete_featurelist":{"tags":[{"description":"The Packages module for WHM API 1.","name":"Packages"},{"name":"Feature Lists","description":"Hosting Plans / Feature Lists"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}}}],"x-tagGroups":[{"tags":["Feature Lists"],"name":"Hosting Plans"}],"paths":{"/delete_featurelist":{"get":{"description":"This function deletes a feature list.","operationId":"delete_featurelist","parameters":[{"required":"true","name":"featurelist","in":"query","schema":{"example":"TestList","type":"string"},"description":"The feature list's name."}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"deleted_featurelist":{"type":"string","description":"The deleted feature list's name.","example":"TestList"}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","description":"The method name called.","example":"delete_featurelist"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"}}}}}}}}},"x-codeSamples":[{"lang":"Shell","label":"CLI","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"}],"tags":["Packages","Feature Lists"],"summary":"Delete feature list","x-cpanel-api-version":"WHM API 1"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"addips":{"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"name":"IPv4 Address Settings","description":"IP Address Management / IPv4 Address Settings"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["IPv4 Address Settings"],"name":"IP Address Management"}],"paths":{"/addips":{"get":{"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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/addips?api.version=1&ips=192.168.0.0&netmask=255.255.255.0","lang":"HTTP","label":"URL"}],"tags":["IP Addresses","IPv4 Address Settings"],"summary":"Add IP addresses","x-cpanel-api-version":"WHM API 1","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":[{"in":"query","name":"ips","required":"true","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":{"value":"192.168.0.20/28","summary":"IPv4 address range"}},"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`.","schema":{"type":"string","example":"255.255.255.0","format":"ipv4"},"name":"netmask","in":"query","required":"true"},{"examples":{"single":{"summary":"A single IP address.","value":"192.0.20.0"},"multiple":{"summary":"Multiple IP addresses.","value":"excludes=192.0.20.0,192.0.20.1"}},"schema":{"type":"string"},"explode":"false","style":"form","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.","in":"query","name":"excludes","required":"false"}],"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The 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"},"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"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"addips","type":"string"}}}}}}}}}}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"listresellers":{"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"description":"Resellers / Account Settings","name":"Account Settings"}],"paths":{"/listresellers":{"get":{"parameters":[],"operationId":"listresellers","description":"This function lists the reseller accounts on the server.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"listresellers","description":"The method name called."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"type":"object","properties":{"reseller":{"type":"array","description":"An array of the server's reseller accounts.","items":{"type":"string","example":"bob"}}}}},"type":"object"}}}}},"x-cpanel-available-version":"11","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  listresellers\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/listresellers?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return all resellers"}}},"x-tagGroups":[{"tags":["Account Settings"],"name":"Resellers"}]},"start_local_cpmove_restore":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API."},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"name":"Backups","tags":["Backup or Restore"]}],"paths":{"/start_local_cpmove_restore":{"get":{"summary":"Restore one cPanel account from a backup","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  start_local_cpmove_restore \\\n  cpmovepath='/home/cpmove-newacct.tar.gz'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/start_local_cpmove_restore?api.version=1&cpmovepath=%2fhome%2fcpmove-newacct.tar.gz"}],"tags":["Backups","Backup or Restore"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"start_local_cpmove_restore","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"properties":{"transfer_session_id":{"type":"string","example":"example202003301756425ugO","description":"The background transfer process ID."}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"88","parameters":[{"required":"true","name":"cpmovepath","in":"query","schema":{"example":"/home/cpmove-newacct.tar.gz","type":"string"},"description":"A filepath that contains the account's `cpmove` tarball or the directory path that contains the extracted `cpmove` tarball.\n\n  **Note:**\n\nYou can use the [pkgacct script](https://go.cpanel.net/ThepkgacctScript) to create a `cpmove` tarball."},{"required":"false","name":"dedicated_ip","in":"query","schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"description":"Whether to assign the account a dedicated IP address.\n* `1` - Assign a dedicated IP address.\n* `0` - Do **not** assign a dedicated IP address.\n\n  **Note:**\n\nThe system **must** have an available IP address."},{"in":"query","name":"delete_archive","required":"false","description":"Whether to delete the `cpmove` tarball or extracted directory, given in the `cpmovepath` parameter, after the system completes the account restoration.\n* `1` - Delete the `cpmove` tarball or extracted directory.\n* `0` - Do **not** delete the `cpmove` tarball or extracted directory.","schema":{"default":"0","example":"0","enum":["0","1"],"type":"integer"}},{"schema":{"oneOf":[{"enum":[".local",".existing"],"type":"string"},{"example":"example-alias","description":"The remote cPanel & WHM linked server node's alias.","type":"string"}],"default":".existing"},"description":"The server on which the account's email will reside after the system completes the transfer.\n* `.local` - Use the local server the account is being restored on.\n* `.existing` - Use the server location defined in the account's backup data. The system defaults to the `.local` parameter if this does **not** work.\n* `ALIAS` - Use a [cPanel & WHM linked node server's alias](https://go.cpanel.net/whmlinkednodes). For example, the `example-alias` for the `servernode.example.com` domain. The system defaults to the `.local` parameter if this does **not** work.","required":"false","name":"mail_location","in":"query"},{"schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"description":"Whether to overwrite an existing account on the server, if one exists.\n* `1` - Overwrite an existing account.\n* `0` - Do **not** overwrite an existing account on the server.","required":"false","name":"overwrite","in":"query"},{"schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"},"description":"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 `root` access to your server, use this parameter to protect your server.\n\n* `1` - Perform a restricted restore.\n* `0` - Do **not** perform a restricted restore.\n\n**Important:**\n\n* This parameter is **experimental**. Do **not** consider it as an effective security control. For more information, read our [restricted restore](https://go.cpanel.net/whmdocsTransferorRestoreacPanelAccount#restricted-restore) documentation.\n* If the account owns PostgreSQL® databases, your server **must** use PostgreSQL version 8.4 or newer.\n* This parameter **only** allows restored accounts to use the `noshell` or [`jailshell`](https://go.cpanel.net/VirtFSJailedShell) environments. If the account uses a different shell, the system will set the account to use the `noshell` environment.\n* If there is an issue with the backup file, the system will **not** restore that part of the backup file. It will also adds a warning to the log file.","required":"false","name":"restricted","in":"query"},{"description":"Whether to perform one of the following actions to the account's A records:\n* `all` - Replace **all** instances of the original server's IP address with the new server's IP address.\n* `basic` - **Only** replace the cPanel provided A records.","schema":{"example":"all","enum":["all","basic"],"default":"all","type":"string"},"in":"query","name":"update_a_records","required":"false"},{"schema":{"example":"example","format":"username","type":"string"},"description":"The username to give to the restored cPanel account. This will default to the username provided in the backup files.","required":"false","name":"username","in":"query"}],"description":"This function performs a full restoration of a single cPanel account from a `cpmove` tarball.","operationId":"start_local_cpmove_restore"}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}]},"enable_monitor_all_enabled_services":{"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Services","description":"Server Administration / Services"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Server Administration","tags":["Services"]}],"paths":{"/enable_monitor_all_enabled_services":{"get":{"x-cpanel-api-version":"WHM API 1","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"services":{"type":"array","items":{"properties":{"monitored":{"type":"integer","description":"Whether the system monitors the service.\n- `1` - Monitored.\n- `0` - Not monitored.","example":"1","enum":["0","1"]},"service":{"description":"The service's name. A valid service name.","example":"cphulkd","type":"string"}},"type":"object"},"description":"An array of objects that contains information about a service and its monitoring status."}},"type":"object"},"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"- `1` - Success\n- `0` - Failed: Check the reason field for more details.","type":"integer"},"command":{"example":"enable_monitor_all_enabled_services","description":"The method name called.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"summary":"Enable monitoring for all services","x-cpanel-available-version":"11.52.0.8","tags":["Server Administration","Services"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enable_monitor_all_enabled_services\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_monitor_all_enabled_services?api.version=1","lang":"HTTP","label":"URL"}],"operationId":"enable_monitor_all_enabled_services","description":"This function enables monitoring for all enabled services."}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"88"},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}}},"create_remote_root_transfer_session":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"name":"cPanel Account Transfer","description":"Transfers / cPanel Account Transfer"}],"paths":{"/create_remote_root_transfer_session":{"get":{"x-cpanel-available-version":"11.44","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"create_remote_root_transfer_session","description":"The method name called.","type":"string"}}},"data":{"properties":{"transfer_session_id":{"type":"string","description":"The transfer session's ID.","example":"vm5docscpanelcopya20140430200606V06z"},"analyze_rawout":{"type":"string","example":"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\",","description":"The HTML output from the analysis of the remote server connection."},"create_rawout":{"type":"string","description":"The HTML output from the creation of the remote server connection.","example":"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\","}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function creates a transfer session as the `root` user.\n\n**Important:**\n\n  For information about the ports that cPanel & WHM uses, read our [How to Configure Your Firewall for cPanel Services](https://go.cpanel.net/firewall) documentation.\n\n**Note:**\n\n  For more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.\n\n### Authentication\nThere are several methods that you can use to authenticate a transfer session with the remote server:\n\n#### Authenticate as root\nIf you use SSH to authenticate as the `root` user, the remote server's SSH must accept `root` logins. For more information read [OpenSSH's `sshd_config`](https://linux.die.net/man/5/sshd_config) documentation.\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 an 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` | The `root` user's SSH key. | The `root` user's SSH key. |\n| `sshkey_passphrase` | *(none)* | The `root` user's SSH key passphrase. |\n\n#### Authenticate as a user\nMany server administrators do not permit direct `root` logins via SSH on their servers.\n* If the remote server forbids root logins, you **must** use another user and their password on the remote server, and then escalate to the `root` user. For more information read [OpenSSH's `sshd_config`](https://linux.die.net/man/5/sshd_config) documentation.\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 username. | The username. |\n| `password` | The user's password. | The user's password. |\n| `root_escalation_method` | `sudo` | `su` |\n| `root_password` | *(none)* | The `root` user'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 username. | The username. |\n| `sshkey_name` | The user's SSH key. | The user's SSH key. |\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)* | The `root` user's password. |","operationId":"create_remote_root_transfer_session","parameters":[{"required":"true","name":"host","in":"query","schema":{"anyOf":[{"type":"string","format":"ipv4","description":"A valid IP address.","example":"192.168.0.0"},{"example":"remote.example.com","description":"A valid domain.","format":"domain","type":"string"}]},"example":"192.168.0.0","description":"The remote server's hostname or IP address."},{"description":"The remote server's SSH port number.","schema":{"default":"22","example":"22","type":"integer","maximum":"65535","minimum":"1"},"in":"query","name":"port","required":"false"},{"in":"query","name":"user","required":"true","description":"The username to use to connect to the remote server.","schema":{"example":"root","type":"string"}},{"description":"The username's password.\n\n**Note:**\n\n Use this parameter if you will authenticate to the remote server with a password. Do **not** use this parameter if you will authenticate to the remote server with an SSH key.","schema":{"type":"string","example":"123456luggage"},"in":"query","name":"password","required":"false"},{"name":"root_escalation_method","in":"query","required":"false","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 the `sshd_config` file's `PermitRootLogin` value is `No`.","schema":{"type":"string","enum":["su","sudo"],"example":"sudo"}},{"name":"root_password","in":"query","required":"false","description":"`root`'s password on the remote server.\n\n**Note:**\n\n Use this parameter if the `sshd_config` file's `PermitRootLogin` value is `No` and you will use the `root` user's password to escalate access.","schema":{"example":"123456luggage","type":"string"}},{"required":"false","name":"sshkey_name","in":"query","schema":{"type":"string","example":"FrancisScott"},"description":"The SSH key's name.\n\n**Note:**\n\n* Use this parameter if you will authenticate to the remote server with an SSH key. Do **not** use this parameter if you will authenticate to the remote server with a password.\n* SSH keys are available in WHM's [*Manage root's SSH Keys*](https://go.cpanel.net/whmdocsManagerootsSSHKeys) interface (*WHM >> Home >> Security Center >> Manage root’s SSH Keys*)."},{"in":"query","name":"sshkey_passphrase","required":"false","description":"The SSH key's passphrase.\n\n**Note:**\n\n Use this parameter if you will authenticate to the remote server with an SSH key, and the key is encrypted.","schema":{"example":"kkwtoowoygidsa","type":"string"}},{"required":"true","in":"query","name":"transfer_threads","schema":{"type":"integer","minimum":"1","example":"1"},"description":"The number of CPU threads to use for transfer sessions."},{"schema":{"example":"1","minimum":"1","type":"integer"},"description":"The number of CPU threads to use for restore sessions.","required":"true","name":"restore_threads","in":"query"},{"schema":{"example":"1","enum":["0","1"],"type":"integer"},"description":"Whether to skip the Restricted Restore system.\n* `1` — Skip.\n* `0` — Do **not** skip.\n\n**Note:**\n\n  If you want to pass the `force` parameter in the WHM API 1 `enqueue_transfer_item` function, you **must** set this parameter to a value of `0`.","required":"true","in":"query","name":"unrestricted_restore"},{"description":"The method by which the transfer system will execute commands on the remote system.\n* `ssh` — Use SSH. The function uses the remote server's indicated SSH `port` value.\n* `whostmgr` — Use the remote server's secure WHM port. This will reject invalid  TLS handshakes.\n* `whostmgr_insecure` — Use the remote server's secure WHM port, but **ignores** any TLS verification failures.","schema":{"type":"string","default":"ssh","example":"ssh","enum":["ssh","whostmgr","whostmgr_insecure"]},"name":"comm_transport","in":"query","required":"true"},{"schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether to transfer reseller privileges.\n* `1` — Transfer.\n* `0` — Do **not** transfer.","required":"true","name":"copy_reseller_privs","in":"query"},{"name":"compressed","in":"query","required":"true","description":"Whether to compress data before transfer.\n* `1` — Compress.\n* `0` — Do **not** compress.","schema":{"example":"1","enum":["0","1"],"type":"integer"}},{"required":"true","name":"unencrypted","in":"query","schema":{"enum":["0","1"],"example":"0","type":"integer"},"description":"Whether to not use SSL to encrypt data.\n* `1` — Do **not** use SSL.\n* `0` — Use SSL."},{"required":"true","in":"query","name":"use_backups","schema":{"type":"integer","enum":["0","1"],"example":"1"},"description":"Whether to use an existing backup instead of packaging the data again if the backup is less than 24 hours old.\n* `1` — Use an existing backup.\n* `0` — Package the data."},{"in":"query","name":"low_priority","required":"true","description":"Whether to run the remote server processes at low priority in order to reduce impact on server performance.\n* `1` — Run at low priority.\n* `0` — Run at high priority.","schema":{"type":"integer","enum":["0","1"],"example":"1"}},{"description":"Whether to use a custom `pkgacct` scripts on the remote server for the transfer session.\n* `1` — Use a custom `pkgacct` script.\n* `0` — Do **not** use a custom script.","schema":{"type":"integer","enum":["0","1"],"example":"1"},"in":"query","name":"enable_custom_pkgacct","required":"true"}],"summary":"Create remote server transfer session as root user","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  create_remote_root_transfer_session \\\n  host='192.168.0.0' \\\n  user='root' \\\n  transfer_threads='1' \\\n  restore_threads='1' \\\n  unrestricted_restore='1' \\\n  comm_transport='ssh' \\\n  copy_reseller_privs='1' \\\n  compressed='1' \\\n  unencrypted='0' \\\n  use_backups='1' \\\n  low_priority='1' \\\n  enable_custom_pkgacct='1'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/create_remote_root_transfer_session?api.version=1&host=192.168.0.0&user=root&transfer_threads=1&restore_threads=1&unrestricted_restore=1&comm_transport=ssh&copy_reseller_privs=1&compressed=1&unencrypted=0&use_backups=1&low_priority=1&enable_custom_pkgacct=1","lang":"HTTP","label":"URL"}],"tags":["Transfers","cPanel Account Transfer"]}}},"x-tagGroups":[{"name":"Transfers","tags":["cPanel Account Transfer"]}]},"terminatereseller":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","paths":{"/terminatereseller":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"acct":{"description":"An array of objects containing the function's output.","items":{"properties":{"user":{"example":"username","format":"username","description":"The account username.","type":"string"},"reason":{"description":"A message of success or the reason for a failure.","example":"username account removed","type":"string"},"output":{"properties":{"raw":{"type":"string","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":"object","description":"An object containing the termination data for the reseller's accounts."},"result":{"enum":["1","0"],"example":"1","description":"Whether the function succeeded.\n\n* `1` — Success.\n* `0` — Failure.","type":"integer"}},"type":"object"},"type":"array"}}},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"command":{"description":"The method name called.","example":"terminatereseller","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11","parameters":[{"name":"user","in":"query","required":"true","description":"The reseller account's username.","schema":{"example":"username","format":"username","type":"string"}},{"required":"true","in":"query","name":"terminatereseller","schema":{"enum":["1","0"],"example":"1","type":"integer"},"description":"Whether to terminate the reseller's main account.\n\n* `1` — Terminate.\n* `0` — Do **not** terminate."}],"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","summary":"Delete reseller and reseller's cPanel accounts","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  terminatereseller \\\n  user='username' \\\n  terminatereseller='1'\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/terminatereseller?api.version=1&user=username&terminatereseller=1"}],"tags":["Resellers","Reseller Account Management"]}}},"x-tagGroups":[{"name":"Resellers","tags":["Reseller Account Management"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"name":"Reseller Account Management","description":"Resellers / Account Management"}]},"set_nameserver":{"paths":{"/set_nameserver":{"get":{"x-cpanel-api-version":"WHM API 1","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"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_nameserver?api.version=1&nameserver=BIND","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"84","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"type":"string","description":"The method name called.","example":"set_nameserver"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"properties":{"message":{"type":"string","example":"Queued task to set nameserver to bind successfully.","description":"A confirmation message from the system."},"nameserver":{"type":"string","example":"bind","enum":["bind","powerdns","disabled"],"description":"The nameserver software.\n* `bind`\n* `powerdns`\n* `disabled`"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"set_nameserver","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.","parameters":[{"schema":{"example":"BIND","enum":["BIND","PowerDNS","Disabled"],"type":"string"},"description":"The nameserver software.\n* `BIND`\n* `PowerDNS`\n* `Disabled`","required":"true","in":"query","name":"nameserver"}]}}},"x-tagGroups":[{"tags":["DNS Cluster Settings"],"name":"DNS"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"name":"DNS Cluster Settings","description":"DNS / DNS Cluster Settings"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"get_all_contact_importances":{"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"name":"Notifications","description":"Server Administration / Notifications"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Server Administration","tags":["Notifications"]}],"paths":{"/get_all_contact_importances":{"get":{"x-cpanel-available-version":"58","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"get_all_contact_importances","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}},"data":{"properties":{"importances":{"items":{"type":"object","properties":{"importance":{"type":"integer","example":"0","description":"The importance of the contact event:\n\n* `1` — High.\n* `2` — Medium.\n* `3` — Low.\n* `0` — Disabled."},"name":{"type":"string","example":"High","description":"The contact event's name:\n\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`"},"event":{"description":"The event's name.\n\n**Note:**\n\nAn asterisk character (`*`) represents all events in the module.","example":"*","type":"string"},"app":{"type":"string","example":"wwwacct","description":"The cPanel & WHM module's name."}}},"description":"An array of objects containing event importance information.","type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"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":[],"x-cpanel-api-version":"WHM API 1","summary":"Return Contact Manager event importance settings","tags":["Server Administration","Notifications"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_all_contact_importances\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_all_contact_importances?api.version=1"}]}}}},"installed_versions":{"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}}}],"x-tagGroups":[{"tags":["Updates"],"name":"Server Administration"}],"paths":{"/installed_versions":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"operating_system_version":{"description":"The version of the server's OS.","example":"7.2","type":"string"},"cpanel_packages":{"items":{"type":"string"},"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"],"type":"array"},"mysql_build":{"oneOf":[{"description":"A version number of MySQL RPM's.","type":"string"},{"description":"MySQL RPM's is **not** installed.","enum":["0"],"type":"integer"}],"example":"5.7.61-1","description":"The MySQL RPM's version number.\n\n* `0` - MySQL RPM's is **not** installed on the server."},"apache_php_versions":{"example":["7.1.33-3.4.2","7.2.33-1.1.1","7.3.21-1.1.1"],"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.","items":{"oneOf":[{"type":"string","description":"A version of PHP for Apache."},{"description":"PHP for Apache is **not** installed on the server.","enum":["0"],"type":"integer"}]},"type":"array"},"bind":{"oneOf":[{"type":"string","description":"A version of BIND."},{"type":"integer","description":"BIND is **not** installed.","enum":["0"]}],"example":"9.9.4-29","description":"The BIND version.\n\n* `0` - BIND is **not** installed on the server."},"mariadb":{"oneOf":[{"type":"string","description":"A version number of MariaDB."},{"enum":["0"],"description":"MariaDB is **not** installed.","type":"integer"}],"description":"The MariaDB® version number.\n\n* `0` - MariaDB is **not** installed on the server.","example":"5.5.65"},"cronie":{"oneOf":[{"description":"A version of the cron daemon.","type":"string"},{"type":"integer","description":"cronie is **not** installed.","enum":["0"]}],"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"},"cpanel_php":{"description":"The system PHP version.\n\n* `0` - System PHP is **not** installed on the server.","example":"7.2.7-4","oneOf":[{"type":"string","description":"A version of cPanel & WHM."},{"description":"cPanel & WHM is **not** installed.","enum":["0"],"type":"integer"}]},"openssh-server":{"example":"clients-6.6.1p1-25","description":"The OpenSSH version.\n\n* `0` - OpenSSH is **not** installed on the server.","oneOf":[{"description":"A version of OpenSSH.","type":"string"},{"description":"OpenSSH is **not** installed.","enum":["0"],"type":"integer"}]},"nscd":{"oneOf":[{"description":"A version number of Name Service Cache Daemon.","type":"string"},{"type":"integer","description":"Name Service Cache Daemon is **not** installed.","enum":["0"]}],"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"},"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"},{"enum":["0"],"description":"Munin is **not** installed.","type":"integer"}]},"postgresql_build":{"example":"0","description":"The PostgreSQL RPM's version number.\n\n* `0` - PostgreSQL RPM's is **not** installed on the server.","oneOf":[{"type":"string","description":"A version number of PostgreSQL RPM's."},{"enum":["0"],"description":"PostgreSQL RPM's is **not** installed.","type":"integer"}]},"clamav":{"example":"0.99.2-1","description":"The ClamAV version.\n\n* `0` - ClamAV is **not** installed on the server.","oneOf":[{"description":"A version of ClamAV.","type":"string"},{"type":"integer","description":"ClamAV is **not** installed.","enum":["0"]}]},"proftpd":{"oneOf":[{"description":"A version of ProFTP.","type":"string"},{"type":"integer","enum":["0"],"description":"ProFTP is **not** installed."}],"example":"1.3.7d","description":"The ProFTP version.\n\n* `0` - ProFTP is **not** installed on the server."},"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"},{"enum":["0"],"description":"EasyApache is **not** installed.","type":"integer"}]},"dovecot":{"example":"2.2.31 (65cde28)","description":"The Dovecot version.\n\n* `0` - Dovecot is **not** installed on the server.","oneOf":[{"description":"A version of Dovecot.","type":"string"},{"description":"Dovecot is **not** installed.","enum":["0"],"type":"integer"}]},"powerdns":{"example":"4.1.10-15","description":"The PowerDNS version.\n\n* `0` - PowerDNS is **not** installed on the server.","oneOf":[{"type":"string","description":"A version of PowerDNS."},{"type":"integer","enum":["0"],"description":"PowerDNS is **not** installed."}]},"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"}]},"rsyslog":{"oneOf":[{"type":"string","description":"A version number of Rsyslog."},{"type":"integer","description":"Rsyslog is **not** installed.","enum":["0"]}],"example":"8.24.0-16","description":"The Rsyslog version number.\n\n* `0` - Rsyslog is **not** installed on the server."},"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"}]},"operating_system_name":{"type":"string","example":"centos","description":"The server's operating system (OS)."},"mailman":{"oneOf":[{"type":"string","description":"A version of Mailman."},{"type":"integer","description":"Mailman is **not** installed.","enum":["0"]}],"example":"2.1.23-9","description":"The Mailman version.\n\n* `0` - Mailman is **not** installed on the server."},"exim":{"oneOf":[{"type":"string","description":"A version of Exim."},{"description":"Exim is **not** installed.","enum":["0"],"type":"integer"}],"description":"The Exim version.\n\n* `0` - Exim is **not** installed on the server.","example":"4.89-2"},"cpanel_and_whm":{"type":"string","example":"11.64.0.9999","description":"The cPanel & WHM version."},"postgresql":{"oneOf":[{"description":"A version of PostgreSQL.","type":"string"},{"description":"PostgreSQL is **not** installed.","enum":["0"],"type":"integer"}],"description":"The PostgreSQL® version.\n\n* `0` - PostgreSQL is **not** installed on the server.","example":"9.2"},"mysql":{"oneOf":[{"description":"A version number of MySQL.","type":"string"},{"enum":["0"],"description":"MySQL is **not** installed.","type":"integer"}],"description":"The MySQL® version number.\n\n* `0` - MySQL is **not** installed on the server.","example":"5.7.61"},"linux_kernel":{"type":"string","example":"3.10.0-327.18.2.e17.x86_64","description":"The Linux® kernel version."},"cron":{"oneOf":[{"description":"A version of the cron daemon.","type":"string"},{"enum":["0"],"description":"ISC / Vixie cron is **not** installed.","type":"integer"}],"example":"3.0pl1-136ubuntu1","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."},"ea_4_packages":{"items":{"type":"string"},"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":[],"type":"array"},"roundcube":{"example":"1.2.4-1","description":"The Roundcube version.\n\n* `0` - Roundcube is **not** installed on the server.","oneOf":[{"type":"string","description":"A version of Roundcube."},{"enum":["0"],"description":"Roundcube is **not** installed.","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"}]},"p0f":{"example":"3.09b-1","description":"The Passive OS Fingerprinting version number.\n\n* `0` - Passive OS Fingerprinting is **not** installed on the server.","oneOf":[{"type":"string","description":"A version number of Passive OS Fingerprinting."},{"type":"integer","enum":["0"],"description":"Passive OS Fingerprinting is **not** installed."}]},"os_packages":{"items":{"type":"string"},"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"],"type":"array"},"spamd":{"example":"3.4.2","description":"The Apache SpamAssassin™ version number.\n\n* `0` - Apache SpamAssassin is **not** installed on the server.","oneOf":[{"type":"string","description":"A version number of Apache SpamAssassin."},{"enum":["0"],"description":"Apache SpamAssassin is **not** installed.","type":"integer"}]},"mariadb_build":{"oneOf":[{"type":"string","description":"A version number of MariaDB RPM's."},{"type":"integer","description":"MariaDB RPM's is **not** installed.","enum":["0"]}],"description":"The MariaDB RPM's version number.\n\n* `0` - MariaDB RPM's is **not** installed on the server.","example":"5.5.65-1"}},"example":{"clamav":"0.99.2-1","postgresql_build":"0","munin":"0","proftpd":"0","easyapache":"4","cronie":"1.4.11-23","openssh-server":"7.4p1-21","nscd":"2.17-222","cpanel_php":"7.2.7-4","mariadb":"0","operating_system_version":"7.2","mysql_build":"5.7.61-1","cpanel_packages":["cpanel-ace-editor-1.2.6-1.cp1166.noarch","cpanel-yui-2.9.0-5.cp1136.noarch"],"apache_php_versions":["0"],"bind":"9.9.4-29","os_packages":["ImageMagick-6.7.8.9-15.el7_2.x86_64","zsh-5.0.2-14.el7.x86_64"],"p0f":"3.09b-1","spamd":"3.4.2","mariadb_build":"0","squirrelmail":"0","ea_4_packages":[],"roundcube":"1.2.4-1","cron":"0","apache_php_default_version":"0","operating_system_name":"centos","mailman":"2.1.23-9","exim":"4.89-2","apache":"2.4.12","postgresql":"0","cpanel_and_whm":"11.64.0.9999","linux_kernel":"3.10.0-327.18.2.el7.x86_64","mysql":"5.7.61","dovecot":"2.2.31 (65cde28)","powerdns":"0","pureftpd":"1.0.45","rsyslog":"8.24.0-16"}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"command":{"description":"The method name called.","example":"installed_versions","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"64","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.","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"in":"query","name":"packages","required":"false"}],"operationId":"installed_versions","description":"This function lists the versions of third-party software that ship with cPanel & WHM.","x-cpanel-api-version":"WHM API 1","summary":"Return third-party software versions","tags":["Updates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  installed_versions\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/installed_versions?api.version=1","label":"URL","lang":"HTTP"}]}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"get_appconfig_application_list":{"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"API Development Tools / Applications","name":"Applications"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"API Development Tools","tags":["Applications"]}],"paths":{"/get_appconfig_application_list":{"get":{"tags":["Server Administration","Applications"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_appconfig_application_list\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_appconfig_application_list?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Return registered applications","operationId":"get_appconfig_application_list","description":"This function lists registered [AppConfig](https://go.cpanel.net/appconfig) applications.","parameters":[],"x-cpanel-available-version":"11.38.1","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"get_appconfig_application_list","type":"string"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Got application list"}}},"data":{"properties":{"cpanel":{"type":"array","description":"An array of objects representing the values set for application installed for cPanel.","items":{"$ref":"#/components/schemas/AppConfig"}},"webmail":{"description":"An array of objects representing the values set for application installed for Webmail.","items":{"$ref":"#/components/schemas/AppConfig"},"type":"array"},"whostmgr":{"description":"An array of objects representing the values set for application installed for WHM.","items":{"$ref":"#/components/schemas/AppConfig"},"type":"array"}},"type":"object"}}}}}}}}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"schemas":{"AppConfig":{"type":"object","properties":{"entryurl":{"type":"string","format":"url-path","description":"The application's WHM entry URL.\n\n**Note:**\n\nThe function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).","example":"roundcube/"},"origin":{"description":"The application's configuration file.\n\n**Note:**\n\nThe function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).","example":"clamavconnector.conf","type":"string"},"group":{"type":"string","example":"mailman","description":"The application's group."},"target":{"example":"_self","description":"The action's target directory.\n\n**Note:**\n\nThe function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).","format":"path","type":"string"},"phpConfig":{"example":"php.ini","description":"The application's `php.ini` file, relative to the `/usr/local/cpanel/3rdparty/etc/` directory.","format":"path","type":"string"},"upgradecall":{"type":"string","example":"/usr/local/roundcube/bin/upgrade","description":"The absolute file path to the application's upgrade script.\n\n**Note:**\n\n* The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).\n* The system passes upgrade information in the following format: `/usr/local/youraddon/bin/upgrade 11.36.0.0 11.38.0.0`, where:\n  * `11.36.0.0` is the **previous** cPanel & WHM version.\n  * `11.38.0.0` is the **current** cPanel & WHM version.","format":"path"},"features":{"type":"array","items":{"example":"roundcube","type":"string"},"description":"The required features to run the application."},"displayname":{"description":"The application's WHM display label.\n\n**Note:**\n\nThe function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).","example":"Roundcube","type":"string"},"acls":{"items":{"example":"any","type":"string"},"description":"The ACL(s) with permission to run the application.","type":"array"},"icon":{"type":"string","example":"roundcube.ico","description":"The application's icon file, relative to the `/usr/local/cpanel/whostmgr/docroot/addon_plugins/` directory.\n\n**Note:**\n\nThe function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig)."},"url":{"type":"string","example":"/3rdparty/roundcube","description":"The application's URL path.","format":"url-path"},"name":{"type":"string","description":"The application's name.","example":"roundcube"},"user":{"description":"The application's username.","example":"roundcube","type":"string"}}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}},"version":{"paths":{"/version":{"get":{"x-cpanel-available-version":"11.38","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"command":{"type":"string","description":"The method name called.","example":"version"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"version":{"type":"string","example":"11.88.0.9999","description":"The server's cPanel & WHM version."}}}}}}}}},"operationId":"version","description":"This function returns [the cPanel & WHM version](https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/) that a server runs.","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return cPanel & WHM version","tags":["Updates"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  version\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/version?api.version=1"}]}}},"x-tagGroups":[{"name":"Server Administration","tags":["Updates"]}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"tags":[{"name":"Updates","description":"The Updates module for WHM API 1."}],"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"create_integration_group":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"tags":[{"name":"Integration","description":"The Integration module for WHM API 1."},{"name":"Links","description":"Integrations / Links"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Links"],"name":"Integrations"}],"paths":{"/create_integration_group":{"get":{"tags":["Integration","Links"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  create_integration_group \\\n  user='username' \\\n  group_id='WHMCS' \\\n  label='WHMCS+Control' \\\n  order='1'\n","lang":"Shell","label":"CLI"},{"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","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Create integration link group","parameters":[{"required":"true","name":"user","in":"query","schema":{"format":"username","example":"username","type":"string"},"description":"The cPanel account name."},{"required":"true","in":"query","name":"group_id","schema":{"type":"string","example":"WHMCS"},"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":"label","required":"true","description":"The label for the group to display in the cPanel interface.","schema":{"example":"WHMCS+Control","type":"string"}},{"schema":{"example":"1","type":"integer","minimum":"1"},"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.","required":"true","in":"query","name":"order"}],"description":"This function creates a group to store integrations links in the cPanel interface.","operationId":"create_integration_group","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok"},"command":{"description":"The method name called.","example":"create_integration_group","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"54"}}}},"fetch_service_ssl_components":{"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"name":"SSL Server Settings","description":"SSL Certificates / SSL Server Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["SSL Server Settings"],"name":"SSL Certificates"}],"paths":{"/fetch_service_ssl_components":{"get":{"description":"This function lists the system's services and their associated certificates.","operationId":"fetch_service_ssl_components","parameters":[],"x-cpanel-available-version":"11.40","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"fetch_service_ssl_components","description":"The method name called.","type":"string"},"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}},"data":{"properties":{"services":{"type":"array","items":{"type":"object","properties":{"cabundle":{"example":"","description":"The Certificate Authority (CA) information.\n\nThis function returns an empty string if no CA bundle exists\nfor the certificate.","type":"string"},"certificate_info":{"type":"object","properties":{"domains":{"type":"array","items":{"example":"example.com","format":"domain","type":"string"},"description":"The domains that correspond to the certificate."},"issuer.organizationName":{"description":"The certificate's Organization Name.","example":"Writer's Guild of America","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","example":"rsaEncryption","enum":["rsaEncryption","id-ecPublicKey"],"type":"string"},"is_self_signed":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — **Not** self-signed."},"issuer_text":{"type":"string","example":"countryName\nUS\nstateOrProvinceName\nUnknown\nlocalityName\nUnknown\norganizationName\nUnknown\norganizationalUnitName\nUnknown\ncommonName\nexample.com\nemailAddress\ntest@example.com","description":"Information about the issuer."},"not_before":{"description":"The certificate's validation date.","format":"unix_timestamp","example":"1569844800","type":"integer"},"issuer.commonName":{"type":"string","example":"example.com","description":"The certificate's Common Name."},"ecdsa_public":{"nullable":"true","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,"type":"string"},"not_after":{"type":"integer","format":"unix_timestamp","description":"The date the certificate expires.","example":"1601467200"},"modulus_length":{"description":"The certificate's modulus size.\n\n* `null` — The certificate's key is **not** an RSA key.","example":null,"nullable":"true","type":"integer"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":null,"nullable":"true","type":"string"},"ecdsa_curve_name":{"type":"string","nullable":"true","example":null,"enum":["prime256v1","secp384r1"],"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."}},"description":"An object containing certificate information data."},"certificate":{"type":"string","example":"-----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-----","format":"pem-certificate","description":"The SSL certificate's contents."},"service":{"description":"The service that the certificate corresponds to.\n\n* `ftp`\n* `exim`\n* `dovecot`\n* `cpanel`","enum":["ftp","exim","dovecot","cpanel"],"example":"ftp","type":"string"},"key":{"format":"pem-private-key","description":"The certificate's private key.","example":"-----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-----","type":"string"}}},"description":"An array of objects containing the certificate information for each service."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"tags":["SSL","SSL Server Settings"],"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  fetch_service_ssl_components\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_service_ssl_components?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Return system services and associated certificates"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}}},"modsec_edit_rule":{"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}],"paths":{"/modsec_edit_rule":{"get":{"x-codeSamples":[{"lang":"Shell","label":"CLI","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"},{"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","lang":"HTTP","label":"URL"}],"tags":["ModSecurity","Rule Settings"],"summary":"Update staged ModSecurity rule","x-cpanel-api-version":"WHM API 1","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":[{"schema":{"type":"string","example":"modsec_vendor_configs/example.conf"},"description":"The ModSecurity configuration file, relative to the `/usr/local/apache/conf/` directory.","required":"true","in":"query","name":"config"},{"in":"query","name":"id","required":"true","description":"The ModSecurity rule's ID.","schema":{"example":"1234567","type":"integer"}},{"required":"true","in":"query","name":"rule","schema":{"example":"SecAction \"pass,id:1234567\"","type":"string"},"description":"The new ModSecurity rule."}],"x-cpanel-available-version":"11.46","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"modsec_edit_rule"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"}}},"data":{"properties":{"rule":{"properties":{"rule":{"type":"string","description":"The ModSecurity rule's text.","example":"SecAction \"pass,id:1234567\""},"meta_msg":{"type":"string","example":"","description":"The ModSecurity rule's description, if one exists."},"disabled":{"type":"integer","description":"Whether the ModSecurity rule is disabled.\n\n* `1` — Disabled.\n* `0` — Enabled.","example":"0","enum":["1","0"]},"id":{"description":"The ModSecurity rule's ID.","example":"1234567","type":"integer","minimum":"1"}},"type":"object","description":"A list of information about the new ModSecurity rule."}},"type":"object"}},"type":"object"}}}}}}}},"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}]},"add_zone_key":{"info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/add_zone_key":{"get":{"x-cpanel-available-version":"86","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"example":"add_zone_key","description":"The method name called.","type":"string"}}},"data":{"properties":{"new_key_id":{"type":"string","example":"1","description":"The security key's ID."}},"type":"object"}}}}}}},"operationId":"add_zone_key","description":"This function generates a DNSSEC zone key for a domain.\n\n**Note:**\n\n* Only servers that run PowerDNS can use DNSSEC. If you call this function on\na 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)\nrecords to your zone record and your registrar.\n* You **cannot** modify the DNSSEC security key. To make any changes, you **must** disable,\ndelete, and re-create the DNSSEC security key.","parameters":[{"required":"true","name":"domain","in":"query","schema":{"type":"string","example":"example.com"},"description":"The domain for which to enable DNSSEC."},{"required":"true","in":"query","name":"algo_num","schema":{"type":"integer","enum":["5","6","7","8","13","14"],"example":"13"},"description":"The algorithm that the system uses to generate the security key.\n\n* `5` — RSA/SHA-1\n* `6` — DSA-NSEC3-SHA1\n* `7` — RSA SHA1-NSEC3-SHA1\n* `8` — RSA/SHA-256\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 a `13` (ECDSA Curve P-256 with SHA-256) value if\nyour registrar supports it."},{"description":"The type of security key to add.\n\n* `ksk` — Key Signing Key.\n* `zsk` — Zone Signing Key.\n\n**Note:**\n\nYou **must** call these values in lowercase.","schema":{"type":"string","example":"ksk"},"in":"query","name":"key_type","required":"true"},{"schema":{"example":"1","enum":["0","1"],"default":"1","type":"integer"},"description":"Whether to activate the new security key.\n\n* `1` — Activate.\n* `0` — Do **not** activate.","required":"false","name":"active","in":"query"},{"required":"false","in":"query","name":"key_size","schema":{"example":"256","enum":["256","384","1024","2048"],"type":"integer"},"description":"The security key size, in bits.\n\n**Note:**\n\nThis parameter defaults to the following values, depending on the `algo_num`\nand `key_type` values:\n\n* `algo_num` = `5`\n  * `ksk` = `2048`\n  * `zsk` = `1024`\n* `algo_num` = `6`\n  * `ksk` = `2048`\n  * `zsk` = `1024`\n* `algo_num` = `7`\n  * `ksk` = `2048`\n  * `zsk` = `1024`\n* `algo_num` = `8`\n  * `ksk` = `2048`\n  * `zsk` = `1024`\n* `algo_num` = `13`\n  * `ksk` and `zsk` = `256`\n* `algo_num` = `14`\n  * `ksk` and `zsk` = `384`"}],"summary":"Create domain's DNSSEC zone key","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  add_zone_key \\\n  domain='example.com' \\\n  algo_num='13' \\\n  key_type='ksk'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/add_zone_key?api.version=1&domain=example.com&algo_num=13&key_type=ksk"}],"tags":["DNS","DNS Security"]}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Security"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Security","name":"DNS Security"}]},"validate_current_installed_exim_config":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"x-tagGroups":[{"tags":["Mail Server Settings"],"name":"Mail"}],"paths":{"/validate_current_installed_exim_config":{"get":{"operationId":"validate_current_installed_exim_config","description":"This function validates the system's current Exim configuration.","parameters":[],"x-cpanel-available-version":"11","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The 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."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"validate_current_installed_exim_config","type":"string"}}},"data":{"type":"object","properties":{"message":{"type":"string","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>","description":"A list of Exim's configuration parameters.","format":"HTML"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  validate_current_installed_exim_config\n","lang":"Shell","label":"CLI"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_installed_exim_config?api.version=1"}],"tags":["Mail","Mail Server Settings"],"summary":"Validate Exim configuration","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}]},"verify_posturl_access":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"description":"WHM API."},"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"description":"Server Administration / Notifications","name":"Notifications"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Server Administration","tags":["Notifications"]}],"paths":{"/verify_posturl_access":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Send notification URL via POST verification","tags":["Server Administration","Notifications"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  verify_posturl_access\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_posturl_access?api.version=1"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"results":{"type":"array","items":{"properties":{"result":{"description":"A list of data about the POST notification URLs.","properties":{"payload":{"description":"A list that contains information about a POST notification URL.","properties":{"success":{"description":"Whether the function returned a\n[2XX HTTP](https://wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_Success)\nstatus code.\n\n* `1` — Success.\n* `0` — Failure.","enum":["0","1"],"example":"1","type":"integer"},"url":{"type":"string","example":"http://www.example.com","format":"url","description":"The URL that provided the response."},"reason":{"type":"string","example":"OK","description":"The response that the server returned."},"content":{"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    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","description":"The URLs content.","type":"string"},"protocol":{"type":"string","description":"The URL's HTTP protocol.","example":"HTTP/1"},"headers":{"type":"object","example":{"e-tag":"z'W/\\\"2e7-Klmw/9Djp5E2M7VZdH2LwFWXX6s\\\"\"","date":"Tue, 05 May 2020 19:10:13 GMT","content-type":"application/json; charset=utf-8","content-length":"743","connection":"keep-alive","set-cookie":"sails.sid=s%3Arpjt9JrVXDIYMxpjyUqLuCtcUxSwbEWX.6ldYuWKV2zqn%2BhmsUlAi7PtsIEd9RXI32y6gjg0gwJA; Path=/; HttpOnly","vary":"Accept-Encoding","server":"nginx"},"description":"An object of the header fields that the request returned.\n\n**Note:**\n\nThis object's returns vary based on the URL's headers."},"status":{"type":"string","description":"The response's\n[HTTP status](https://wikipedia.org/wiki/List_of_HTTP_status_codes)\ncode.","example":"200"}},"type":"object"},"message_id":{"type":"string","description":"The test message's ID.","example":"88M7"}}},"url":{"type":"string","format":"url","description":"The URL and query string for the POST notification URL.","example":"https://postman-echo.com/post"}}},"description":"An array of objects containing POST notification URL data."}},"type":"object"},"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"command":{"type":"string","example":"verify_posturl_access","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.52","parameters":[],"operationId":"verify_posturl_access","description":"This function calls the WHM API 1 `send_test_posturl` function for\nyour specified POST notification URLs. Users can specify POST notification\nURLs in the *Contact Information* section of WHM's\n[*Basic WebHost Manager Setup*](https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup)\ninterface (*WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup*).\n\n**Note:**\n\nIf the *Contact Information* section of WHM's\n[*Basic WebHost Manager Setup*](https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup)\ninterface (*Home >> Server Configuration >> Basic WebHost Manager Setup*) contains\nmultiple POST URLs, the function will return an array that contains the results\nfor each URL."}}}},"create_remote_user_transfer_session":{"paths":{"/create_remote_user_transfer_session":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"transfer_session_id":{"type":"string","example":"vm5docscpanelnoroo201402251939519hmy","description":"The transfer session's ID."}},"type":"object"},"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","description":"The method name called.","example":"create_remote_user_transfer_session"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"11.44","parameters":[{"schema":{"type":"string","example":"hostname.example.com","format":"domain"},"description":"The server hostname for the account.","required":"true","in":"query","name":"host"},{"in":"query","name":"password","required":"true","description":"The account's password.","schema":{"type":"string","example":"12345luggage"}},{"name":"unrestricted_restore","in":"query","required":"true","description":"Whether to skip the Restricted Restore process.\n* `1` - Skip Restricted Restore.\n* `0` - Use Restricted Restore.\n\n**Note:**\n\nYou **must** set this parameter to a value of 1.","schema":{"example":"1","enum":["1"],"type":"integer"}}],"operationId":"create_remote_user_transfer_session","description":"This function creates a transfer session with a non-root user to a remote server.\n\n**Important:**\n\n* The source and target servers must be able to communicate over port `2087` to use this feature.\n* The source and target servers must also be able to communicate over the port that your servers use for SSH connections.\n* For more information about the ports that cPanel & WHM uses, read our [How to Configure Your Firewall for cPanel & WHM Services](https://go.cpanel.net/firewall) documentation.\n\n**Note:**\n\nFor more information about how this function works with other functions in the transfer and restore process, read our [Guide to Transfer and Restore API Functions](https://go.cpanel.net/transferrestoreAPIguide) documentation.","summary":"Create remote server transfer session","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  create_remote_user_transfer_session \\\n  host='hostname.example.com' \\\n  password='12345luggage' \\\n  unrestricted_restore='1'\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/create_remote_user_transfer_session?api.version=1&host=hostname.example.com&password=12345luggage&unrestricted_restore=1"}],"tags":["Transfers","cPanel Account Transfer"]}}},"x-tagGroups":[{"name":"Transfers","tags":["cPanel Account Transfer"]}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM."}],"tags":[{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"name":"cPanel Account Transfer","description":"Transfers / cPanel Account Transfer"}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"domainuserdata":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"tags":[{"name":"Domain Information","description":"Accounts / Domain Information"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"name":"Accounts","tags":["Domain Information"]}],"paths":{"/domainuserdata":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  domainuserdata \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/domainuserdata?api.version=1&domain=example.com","label":"URL","lang":"HTTP"}],"tags":["Domain Information"],"summary":"Return domain user information","x-cpanel-api-version":"WHM API 1","parameters":[{"in":"query","name":"domain","required":"true","description":"The account's main domain.","schema":{"type":"string","example":"example.com"}}],"description":"This function retrieves domain data.","operationId":"domainuserdata","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"userdata":{"description":"The domain information.","type":"object","properties":{"customlog":{"type":"array","description":"A list of objects of Apache log information.","items":{"type":"object","properties":{"target":{"type":"string","example":"/usr/local/apache/domlogs/example.com","description":"An Apache custom log's location. The absolute path to the log file."},"format":{"type":"string","description":"The custom log's format. A valid Apache log format.","example":"combined"}}}},"owner":{"type":"string","description":"The WHM user who owns the cPanel account. A valid WHM username.","example":"root"},"homedir":{"type":"string","example":"/home/username","description":"The path to the domain's home directory. The absolute path to the domain's home directory."},"group":{"type":"string","description":"The account's group name. A valid group name.","example":"reseller_username"},"scriptalias":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"/cgi-bin/","description":"The alias URL. This URL redirects to the path URL. A valid URL or file path."},"path":{"type":"string","example":"/home/user/public_html/cgi-bin/","description":"The path to Apache's CGI scripts. The url alias redirects to this location. A valid URL or absolute file path."}}},"description":"an object containing Apache ScriptAlias information."},"userdirprotect":{"type":"string","description":"The domain's setting for the Apache mod_userdir Tweak.\n- On\n- Off","example":"Off"},"ip":{"type":"string","description":"The domain's IP address. A valid IP address.","example":"10.0.0.1"},"serveradmin":{"example":"owner@example.com","description":"The account owner's contact email address. A valid email address.","type":"string"},"serveralias":{"description":"The domain's aliases. A space-separated list of domain aliases.","example":"parkeddomain.com www.parkeddomain.com seconddomain.com","type":"string"},"hascgi":{"type":"integer","description":"Whether CGI is enabled for the account.\n- 1  Enabled.\n- 0  Disabled.","example":"1","enum":["0","1"]},"servername":{"type":"string","description":"The main domain on the domain's account. A valid domain name.","example":"example.com"},"usecanonicalname":{"type":"string","example":"Off","description":"The domain's setting for canonical names (CNAMEs).\n- On\n- Off"},"phpopenbasedirprotect":{"description":"Whether the PHP open_basedir tweak is enabled.\n- 1  Enabled.\n- 0  Disabled.","enum":["0","1"],"example":"1","type":"integer"},"user":{"example":"user","description":"The cPanel account username. A valid cPanel username.","type":"string"},"port":{"example":"80","description":"Apache's port to access the domain. A valid port number.","type":"integer"},"documentroot":{"type":"string","description":"The path to the domain's document root. A valid filepath.","example":"/home/username/public_html"}}}}},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Obtained userdata.","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"domainuserdata"},"result":{"enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","type":"integer"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.32"}}}},"current_mysql_version":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"tags":[{"name":"Databases","description":"The Databases module for WHM API 1."},{"name":"Manage MySQL Server","description":"Databases / Manage MySQL Server"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["Manage MySQL Server"],"name":"Databases"}],"paths":{"/current_mysql_version":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"server":{"description":"The server's database engine.\n* `mysql`\n* `mariadb`","default":"mysql","example":"mysql","enum":["mysql","mariadb"],"type":"string"},"version":{"example":"8.0","description":"The version number, in `major`.`minor` format.","type":"string"}},"type":"object"},"metadata":{"properties":{"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details."},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"description":"The method name called.","example":"current_mysql_version","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"cPanel 11.48","parameters":[],"operationId":"current_mysql_version","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.","summary":"Return MySQL version","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  current_mysql_version\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/current_mysql_version?api.version=1","label":"URL","lang":"HTTP"}],"tags":["Databases","Manage MySQL Server"]}}}},"modsec_clone_rule":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/modsec_clone_rule":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"rule":{"description":"A list of information about the cloned ModSecurity rule.","type":"object","properties":{"rule":{"type":"string","description":"The rule's text that includes the new rule ID.","example":"SecRule REQUEST_URI \"/rejected.php\" \"deny,auditlog,msg:'Rejected request',id:'1'\""},"config_active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":["1","0"],"example":"1","type":"integer"},"meta_msg":{"type":"string","description":"The rule's description.","example":"Rejected request"},"config":{"example":"modsec2.user.conf","description":"The rule's ModSecurity configuration file.","type":"string"},"id":{"description":"The rule's ID number.","example":"123456789","minimum":"1","type":"integer"},"vendor_active":{"enum":["1","0"],"example":"0","description":"Whether the vendor is active.\n\n* `1` — Active.\n* `0` — **Not** active.","type":"integer"},"vendor_id":{"example":"YourVendor","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.","type":"string"},"staged":{"enum":["1","0"],"example":"1","description":"Whether the rule is staged.\n\n* `1` — Staged.\n* `0` — **Not** staged.","type":"integer"},"disabled":{"type":"integer","enum":["1","0"],"example":"0","description":"Whether the rule is disabled.\n\n* `1` — Disabled.\n* `0` — Enabled."}}}}},"metadata":{"properties":{"result":{"type":"integer","enum":["1","0"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"modsec_clone_rule"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11.48","parameters":[{"schema":{"type":"string","example":"modsec2.user.conf"},"description":"The rule's ModSecurity configuration file.","required":"true","in":"query","name":"config"},{"schema":{"example":"123456789","minimum":"1","type":"integer"},"description":"The existing rule's ID.","required":"true","in":"query","name":"id"}],"operationId":"modsec_clone_rule","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.","x-cpanel-api-version":"WHM API 1","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"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_clone_rule?api.version=1&config=modsec2.user.conf&id=123456789"}]}}},"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"name":"Rule Settings","description":"Web Server Security (ModSecurity) / Rule Settings"}]},"list_blocked_incoming_email_domains":{"openapi":"3.0.2","info":{"contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API","description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Mail","description":"The Mail module for WHM API 1."},{"description":"Mail / Spam Management","name":"Spam Management"}],"paths":{"/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":[],"x-cpanel-available-version":"84","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","example":"list_blocked_incoming_email_domains","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"domains":{"description":"An array of objects that contains each blocked domain.","items":{"type":"object","properties":{"domain":{"type":"string","description":"The blocked domain.","example":"example.com"}}},"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  list_blocked_incoming_email_domains\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/list_blocked_incoming_email_domains?api.version=1","lang":"HTTP","label":"URL"}],"tags":["Mail","Spam Management"],"summary":"Return blocked email domains list","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Mail","tags":["Spam Management"]}]},"update_linked_server_node":{"tags":[{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Nodes","name":"Server Nodes"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"tags":["Server Nodes"],"name":"Server Administration"}],"paths":{"/update_linked_server_node":{"get":{"parameters":[{"schema":{"example":"example","type":"string"},"description":"The name of a linked remote cPanel server node.","required":"true","name":"alias","in":"query"},{"schema":{"type":"string","example":"23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H"},"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.","required":"false","name":"api_token","in":"query"},{"name":"hostname","in":"query","required":"false","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.","schema":{"type":"string","example":"example.com"}},{"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.","schema":{"example":"root","type":"string"},"in":"query","name":"username","required":"false"},{"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.","schema":{"default":"1","enum":["0","1"],"example":"0","type":"integer"},"name":"skip_tls_verification","in":"query","required":"false"}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"update_linked_server_node","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"}}}}}}}}},"x-cpanel-available-version":"86","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  update_linked_server_node \\\n  alias='example'\n","label":"CLI","lang":"Shell"},{"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","summary":"Update linked server node settings"}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"}},"package_manager_list_packages":{"tags":[{"description":"The RPM module for WHM API 1.","name":"RPM"},{"name":"List Package Information","description":"System Package Management / List Package Information"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"x-tagGroups":[{"name":"System Package Management","tags":["List Package Information"]}],"paths":{"/package_manager_list_packages":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Return available RPM packages","tags":["RPM","List Package Information"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  package_manager_list_packages\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_list_packages?api.version=1","label":"URL","lang":"HTTP"}],"x-cpanel-available-version":"11.52","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"packages":{"description":"An array of objects that contains the RPM packages on the system.","items":{"properties":{"package":{"type":"string","description":"An RPM package."}},"type":"object"},"example":[{"package":"MariaDB-client"},{"package":"MariaDB-common"}],"type":"array"}},"description":"A list of RPM objects that match the requested `state`."},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"package_manager_list_packages","description":"The method name called."},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function lists information about the system's available RPM packages.","operationId":"package_manager_list_packages","parameters":[{"in":"query","name":"state","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.","schema":{"type":"string","default":"any","example":"installed","enum":["any","installed","not_installed","updatable"]}}]}}},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"}},"listacls":{"x-tagGroups":[{"tags":["Account Permissions"],"name":"Resellers"}],"paths":{"/listacls":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  listacls\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listacls?api.version=1"}],"tags":["Resellers","Account Permissions"],"summary":"Return all privilege lists and settings","x-cpanel-api-version":"WHM API 1","parameters":[],"description":"This function lists the server's\n[Access Control Lists (ACLs)](https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists)\nand each list's privileges.","operationId":"listacls","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"type":"string","example":"listacls","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"properties":{"acl":{"type":"array","items":{"type":"object","properties":{"privileges":{"properties":{"show-bandwidth":{"type":"integer","description":"Whether to allow the reseller to view account bandwidth usage.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"limit-bandwidth":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to modify bandwidth limits\n(quotas).\n\n* `1` — Allow.\n* `0` — Do not allow.\n\n**Warning:**\n\nIf you do not use resource limits, a value of `1` allows\nresellers to circumvent package limits for disk space."},"edit-mx":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to edit MX entries.\n\n* `1` — Allow.\n* `0` — Do not allow.","type":"integer"},"digest-auth":{"type":"integer","description":"Whether to allow the reseller to manage Digest Authentication.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"thirdparty":{"type":"integer","description":"Whether to allow the reseller to manage third-party services.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"allow-emaillimits-pkgs":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to create packages with email quotas\nthat are **not** the default quotas.\n\n* `1` — Allow.\n* `0` — Do not allow."},"generate-email-config":{"description":"Whether to allow the reseller to generate a mobile configuration\nprofile for an email account.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"ns-config":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to manage nameserver records.\n\n* `1` — Allow.\n* `0` — Do not allow.","type":"integer"},"ssl-buy":{"type":"integer","description":"Whether to allow the reseller to purchase SSL certificates.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"]},"kill-dns":{"description":"Whether to allow the reseller to remove DNS zones.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"],"type":"integer"},"demo-setup":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to enable demo mode for accounts.\n\n* `1` — Allow.\n* `0` — Do not allow.","type":"integer"},"allow-unlimited-pkgs":{"description":"Whether to allow the reseller to create packages with unlimited\nfeatures.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"add-pkg":{"description":"Whether to allow the reseller to add and remove hosting plans\n(packages).\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"passwd":{"description":"Whether to allow the reseller to change passwords.\n\n* `1` — Allow.\n* `0` — Do not allow.\n\n**Note:**\n\nThis privilege allows an API token user to change account\npasswords and log in with a new password. For more information,\nread our\n[Manage API Tokens](https://go.cpanel.net/ManageAPITokens)\ndocumentation.","example":"1","enum":["1","0"],"type":"integer"},"allow-parkedcreate":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to create packages with parked\ndomains (aliases).\n\n* `1` — Allow.\n* `0` — Do not allow.","type":"integer"},"create-dns":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the reseller to add DNS zones.\n\n* `1` — Allow.\n* `0` — Do not allow."},"upgrade-account":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to upgrade or downgrade accounts.\n\n* `1` — Allow.\n* `0` — Do not allow.","type":"integer"},"cpanel-api":{"description":"Whether to allow the reseller to execute cPanel API 1, cPanel\nAPI 2 and UAPI functions via WHM.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"mysql-info":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to retrieve MySQL® database and\nuser data.\n\n* `1` — Allow.\n* `0` — Do not allow."},"cors-proxy-get":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the reseller to perform Cross-Origin Resource\nSharing (CORS) HTTP requests.\n\n* `1` — Allow.\n* `0` — Do not allow."},"track-email":{"type":"integer","description":"Whether to allow resellers to view reports about email message\ndelivery attempts from their account.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"locale-edit":{"description":"Whether to allow the reseller to create and modify locales on\nthe server.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"],"type":"integer"},"all":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to grant the reseller **all** ACL privileges.\n\n**Warning:**\n\nA value of `1` grants `root`-level privileges to the reseller.\n\n* `1` — Allow.\n* `0` — Do not allow."},"add-pkg-shell":{"type":"integer","description":"Whether to allow the reseller to create packages with shell\naccess.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"allow-unlimited-disk-pkgs":{"description":"Whether to allow the reseller to create packages with unlimited\ndisk space.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"suspend-acct":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the reseller to suspend or unsuspend accounts.\n\n* `1` — Allow.\n* `0` — Do not allow."},"cpanel-integration":{"description":"Whether to allow the reseller to manage cPanel integration\nlinks.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"],"type":"integer"},"restart":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the reseller to restart services.\n\n* `1` — Allow.\n* `0` — Do not allow."},"ssl-info":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to view their server's SSL\ninformation.\n\n* `1` — Allow.\n* `0` — Do not allow."},"clustering":{"type":"integer","description":"Whether to allow the reseller to use DNS clusters.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"frontpage":{"type":"integer","deprecated":"true","description":"Whether to allow the reseller to manage Microsoft® FrontPage®\nExtensions.\n\n* `1` — Allow.\n* `0` — Do not allow.\n\n**Note:**\n\ncPanel & WHM ignores all Microsoft FrontPage settings and parameters.","example":"1","enum":["1","0"]},"allow-unlimited-bw-pkgs":{"type":"integer","description":"Whether to allow the reseller to create packages with unlimited\nbandwidth.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"manage-styles":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the reseller to manage their server's cPanel\nstyles.\n\n* `1` — Allow.\n* `0` — Do not allow."},"allow-addoncreate":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to create packages with addon\ndomains.\n\n* `1` — Allow.\n* `0` — Do not allow."},"status":{"description":"Whether to allow the reseller to view the server's status.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"],"type":"integer"},"edit-account":{"type":"integer","description":"Whether to allow the reseller to edit accounts.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"]},"edit-dns":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to edit DNS zones.\n\n* `1` — Allow.\n* `0` — Do not allow."},"basic-whm-functions":{"description":"Whether to allow the reseller to access basic cPanel & WHM\noptions.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"],"type":"integer"},"ssl":{"type":"integer","description":"Whether to allow the reseller to perform SSL site management.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"edit-pkg":{"type":"integer","description":"Whether to allow the reseller to edit hosting plans (packages).\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"]},"news":{"description":"Whether to allow the reseller to modify the server's news.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"manage-oidc":{"description":"Whether to allow the reseller to manage external authentication\nfor their accounts.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"],"type":"integer"},"ssl-gencrt":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to generate SSL certificates.\n\n* `1` — Allow.\n* `0` — Do not allow."},"mailcheck":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to troubleshoot mail delivery.\n\n* `1` — Allow.\n* `0` — Do not allow.","type":"integer"},"manage-dns-records":{"type":"integer","description":"Whether to allow the reseller to manage DNS records.\n\n* `1` — Allow.\n* `0` — Do not allow.","example":"1","enum":["1","0"]},"create-acct":{"type":"integer","description":"Whether to allow the reseller to create accounts.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"quota":{"type":"integer","description":"Whether to allow the reseller to modify quotas.\n\n* `1` — Allow.\n* `0` — Do not allow.\n\n**Warning:**\n\nIf you do not use resource limits, a value of `1`\nallows resellers to circumvent package limits for disk space.","enum":["1","0"],"example":"1"},"stats":{"description":"Whether to allow the reseller to view server information.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"allow-shell":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to create accounts with shell\naccess.\n\n* `1` — Allow.\n* `0` — Do not allow."},"rearrange-accts":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to rearrange accounts.\n\n* `1` — Allow.\n* `0` — Do not allow."},"list-accts":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the reseller to view the list of accounts.\n\n* `1` — Allow.\n* `0` — Do not allow."},"resftp":{"type":"integer","description":"Whether to allow the reseller to resync FTP passwords.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1"},"park-dns":{"description":"Whether to allow the reseller to park DNS zones.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"create-user-session":{"description":"Whether to allow the reseller to create a new temporary user\nsession for a specified service.\n\n* `1` — Allow.\n* `0` — Do not allow.\n\n**Note:**\n\nThis ACL privilege allows an API token user to bypass any\nrestrictions that you set on the API token. For more information,\nread our\n[Manage API Tokens](https://go.cpanel.net/ManageAPITokens)\ndocumentation.","example":"1","enum":["1","0"],"type":"integer"},"kill-acct":{"description":"Whether to allow the reseller to terminate accounts.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"basic-system-info":{"type":"integer","example":"1","enum":["1","0"],"description":"Whether to allow the user to retrieve basic system information.\n\n* `1` — Allow.\n* `0` — Do not allow."},"acct-summary":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to view an account summary.\n\n* `1` — Allow.\n* `0` — Do not allow."},"add-pkg-ip":{"description":"Whether to allow the reseller to create packages with a\ndedicated IP address.\n\n* `1` — Allow.\n* `0` — Do not allow.","enum":["1","0"],"example":"1","type":"integer"},"manage-api-tokens":{"example":"1","enum":["1","0"],"description":"Whether to allow the reseller to manage API tokens.\n\n* `1` — Allow.\n* `0` — Do not allow.\n\n**Note:**\n\nThis ACL privilege allows an API token user to bypass any\nrestrictions that you set on the API token. For more information,\nread our\n[Manage API Tokens](https://go.cpanel.net/ManageAPITokens)\ndocumentation.","type":"integer"},"viewglobalpackages":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to use all\n[global packages](https://go.cpanel.net/resellerpackages).\n\n* `1` — Allow.\n* `0` — Do not allow."},"list-pkgs":{"type":"integer","enum":["1","0"],"example":"1","description":"Whether to allow the reseller to view existing hosting plans.\n\n* `1` — Allow.\n* `0` — Do not allow."}},"type":"object","description":"A list of ACL privileges, including any third-party ACL privileges\nthat exist for the user."},"name":{"type":"string","description":"The ACL's name.","example":"acl1"}}},"description":"An array of objects containing ACL settings."}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11"}}},"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"description":"Resellers / Account Permissions","name":"Account Permissions"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","description":"WHM API."},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}}},"is_eligible_for_trial":{"x-tagGroups":[{"name":"Server Administration","tags":["System Information"]}],"paths":{"/is_eligible_for_trial":{"get":{"x-cpanel-available-version":"90","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"},"command":{"type":"string","example":"is_eligible_for_trial","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details."}}},"data":{"type":"object","properties":{"is_eligible":{"type":"integer","description":"Whether the server is eligible for trial.\n* `1` -  Is eligible for a trial license.\n* `0` -  Is not eligible for a trial license.","example":"0","enum":["0","1"]},"ip":{"type":"string","format":"ipv4","description":"A valid IPv4 address.","example":"192.0.2.0"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"description":"This function checks to see if the server is eligible for a trial license.","operationId":"is_eligible_for_trial","x-cpanel-internal-only":"true","parameters":[{"required":"false","name":"ip","in":"query","schema":{"type":"string","example":"192.0.2.0","format":"ipv4"},"description":"The IPv4 address.\n\n**NOTE:**\n\nThis parameter defaults to the server's main IP address."}],"summary":"Determine if server is eligible for trial","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  is_eligible_for_trial\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/is_eligible_for_trial?api.version=1","label":"URL","lang":"HTTP"}],"tags":["System Information"]}}},"tags":[{"description":"The Server Administration module for WHM API 1.","name":"System Information"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.91.0.9999","description":"WHM API."},"openapi":"3.0.2"},"fetch_connected_application":{"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.98.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"paths":{"/fetch_connected_application":{"post":{"x-codeSamples":[{"lang":"Shell","label":"CLI","source":"whmapi1 --output=jsonpretty \\\n  fetch_connected_application \\\n  name='application-1'\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_connected_application?api.version=1&name=application-1","label":"URL","lang":"HTTP"}],"tags":["Server Administration","Connected Applications"],"summary":"Fetch application connection information","x-cpanel-api-version":"WHM API 1","description":"Retrieve the connection information related to a application that has been granted\naccess to this server. This data may include any number of properties, but its\nprimary purpose is to associate API tokens and public/private key pairs and similar\nresources with a specific connected application.","operationId":"fetch_connected_application","parameters":[{"description":"The name of the connected application.","schema":{"type":"string","example":"application-1"},"name":"name","in":"query","required":"true"}],"x-cpanel-available-version":"98","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"data":{"additionalProperties":{},"properties":{"privileges_granted":{"example":["list-accts","list-resellers","create-user-session","acct-summary","connected-applications"],"description":"The actual privileges granted by the user.","items":{"type":"string"},"type":"array"},"private_key":{"type":"string","description":"The name of the private key, if any, used by encryption, signing, or other security schemes used when communicating with this connected application.","example":"FEF6253E6A122532430D"},"token_name":{"example":"Application 1 API Token","description":"The name of the API token, if any, sent to the connected application to allow that application to make API calls on this server.","type":"string"},"public_key":{"example":"AAF6253E6A1225324305623EE","description":"The name of the public key, if any, sent to the connected application during registration.","type":"string"},"jwt":{"description":"The contents of a JSON Web Token used during registration, or updates.","example":{"challenge":"ddd13a92-d55e-4818-a960-9776ede6cd74,","iss_desc":"Sample application","name":"John Doe,","email":"john.doe@email.example,","iss":"https://application-1.com","scope":["admin:users,","admin:resellers","admin:domains"],"exp":"1401912171,","callback_url":"https://application-1.com/api/si/servers/registrations/callback,","ips":["1.1.1.1","2.2.2.2"],"redirect_url":"https://application-1/redirect,","state":"xyz"},"additionalProperties":{},"type":"object"}},"type":"object","description":"Data associated with the connected application. There are a few predefined elements, but any additional data may be stored here as well."},"name":{"type":"string","description":"The name of the connected application.","example":"application-1"}}},"metadata":{"properties":{"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","example":"fetch_connected_application","description":"The method name called."},"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}}}}}}},"x-tagGroups":[{"name":"Server Administration","tags":["Connected Applications"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Server Administration","description":"The Server Administration module for WHM API 1."},{"name":"Connected Applications","description":"Server Administration / Connected Applications"}]},"initialwebsite_create":{"openapi":"3.0.2","info":{"description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}}}],"tags":[{"description":"Accounts Creation / Accounts","name":"Account Creation"}],"paths":{"/initialwebsite_create":{"get":{"tags":["Account Creation"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  initialwebsite_create\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/initialwebsite_create?api.version=1"}],"x-cpanel-api-version":"WHM API 1","summary":"Create initial website for an account","operationId":"initialwebsite_create","description":"This function is for internal use only.","x-cpanel-internal-only":"true","parameters":[],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","example":"1","enum":["0","1"],"type":"integer"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"description":"The method name called.","example":"initialwebsite_create","type":"string"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["Account Creation"],"name":"Accounts"}]},"disable_dnssec_for_domains":{"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API","description":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"servers":[{"variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"DNS","description":"The DNS module for WHM API 1."},{"description":"DNS / DNS Security","name":"DNS Security"}],"paths":{"/disable_dnssec_for_domains":{"get":{"operationId":"disable_dnssec_for_domains","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.","parameters":[{"required":"true","name":"domain","in":"query","schema":{"format":"domain","type":"string"},"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-alternative":{"summary":"Multiple domains","value":"domain=example.com&domain=example1.com&domain=example2.com"},"multiple":{"value":"domain=example.com&domain-1=example1.com&domain-2=example2.com","summary":"Multiple domains"},"single":{"summary":"A single domain.","value":"example.com"}}}],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"domains":{"items":{"properties":{"domain":{"type":"string","description":"The domain for which the system disabled DNSSEC.","format":"domain","example":"example.com"},"disabled":{"enum":["0","1"],"example":"1","description":"Whether the system disabled DNSSEC.\n* `1` - Disabled.\n* `0` - The system failed to disable DNSSEC.","type":"integer"}},"type":"object"},"description":"An array of objects that contains information about each domain.","type":"array"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_dnssec_for_domains","type":"string"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1","type":"integer"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"tags":["DNS","DNS Security"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  disable_dnssec_for_domains \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","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","summary":"Disable DNSSEC on domain"}}},"x-tagGroups":[{"name":"DNS","tags":["DNS Security"]}]},"ea4_metainfo":{"paths":{"/ea4_metainfo":{"get":{"parameters":[],"operationId":"ea4_metainfo","description":"This function returns the contents of the `/etc/cpanel/ea4/ea4-metainfo.json` file.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."},"result":{"type":"integer","description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"command":{"type":"string","description":"The method name called.","example":"ea4_metainfo"},"version":{"type":"integer","example":"1","description":"The version of the API function."}}},"data":{"description":"Contents of the `/etc/cpanel/ea4/ea4-metainfo.json` file.","example":{"type":"object","default_php_package":"ea-php72","additional_packages":["ea-nginx","ea-example"],"default_php_handler":"cgi"},"additionalProperties":{"type":"object","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":"HTTP Request was successful."}},"x-cpanel-available-version":"80","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  ea4_metainfo\n","label":"CLI","lang":"Shell"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_metainfo?api.version=1"}],"tags":["EasyApache","EasyApache Settings"],"summary":"Return ea4-metainfo.json file contents","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Web Server Configuration","tags":["EasyApache Settings"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"name":"EasyApache","description":"The EasyApache module for WHM API 1."},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2"},"createacct":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API."},"openapi":"3.0.2","x-tagGroups":[{"tags":["Account Creation"],"name":"Accounts"}],"paths":{"/createacct":{"get":{"summary":"Create cPanel account","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  createacct \\\n  username='username' \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/createacct?api.version=1&username=username&domain=example.com"}],"tags":["Account Creation"],"x-cpanel-available-version":"11.32","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"nameserver2":{"type":"string","example":"ns2.example.com","description":"The account's secondary nameserver."},"nameserverentry3":{"description":"The tertiary nameserver's DNS name.","example":"dnsentry3","nullable":"true","type":"string"},"nameserver4":{"example":"ns4.example.com","description":"The account's quaternary nameserver.","type":"string"},"nameserver3":{"type":"string","example":"ns3.example.com","description":"The account's tertiary nameserver."},"nameservera3":{"nullable":"true","example":"192.0.2.3","format":"ipv4","description":"The account's tertiary nameservers' IP address.","type":"string"},"ip":{"format":"ipv4","description":"The account's primary nameserver's IP address.","example":"192.0.2.0","type":"string"},"nameserverentry2":{"description":"The secondary nameserver's DNS name.","example":"dnsentry2","nullable":"true","type":"string"},"nameservera4":{"type":"string","nullable":"true","example":"192.0.2.4","format":"ipv4","description":"The account's quaternary nameservers' IP address."},"nameservera2":{"type":"string","nullable":"true","example":"192.0.2.2","description":"The account's secondary nameservers' IP address.","format":"ipv4"},"nameservera":{"type":"string","description":"The account's primary nameservers' IP address.","format":"ipv4","example":"192.0.2.1","nullable":"true"},"nameserver":{"type":"string","example":"ns1.example.com","description":"The account's primary nameserver."},"nameserverentry":{"example":"dnsentry1","description":"The primary nameserver's DNS name.","nullable":"true","type":"string"},"nameserverentry4":{"nullable":"true","description":"The quaternary nameserver's DNS name.","example":"dnsentry4","type":"string"},"package":{"description":"The account's plan (package) name.","example":"my_new_package","type":"string"}},"type":"object"},"metadata":{"properties":{"output":{"description":"An object that contains the function's raw output information.","type":"object","properties":{"raw":{"example":"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","description":"The raw output from the account creation operation. This return may contain HTML code.","type":"string"}}},"reason":{"type":"string","example":"Account Creation Ok","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."},"command":{"description":"The method name called.","example":"createacct","type":"string"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"}}}}}}}}},"operationId":"createacct","description":"This function creates a cPanel account and sets up its domain information.\n\n**Note:**\n\n* On 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).","parameters":[{"schema":{"maxLength":"16","type":"string","example":"username"},"description":"The new account's username. cPanel usernames **must** adhere to the following criteria:\n* The first eight characters of a username **must** be unique.\n* A username **cannot** begin with a number or the test string.\n\n**Note:**\n\n* Use the `Cpanel::Validate::Username` Perl module to validate usernames before you call this function. For more information, read the `/usr/local/cpanel/Cpanel/Validate/Username.pod` file.\n* The system will automatically convert this value to all lowercase letters.\n* MySQL's unique character limitations do **not** exist on servers that use MariaDB.","required":"true","in":"query","name":"username"},{"schema":{"example":"example.com","type":"string"},"description":"The account's main domain.\n\n**Note:**\n\n* If you do not provide a domain, the system will automatically create a temporary domain for the account.\n* For more information about temporary domains, read our [Temporary Domains](https://go.cpanel.net/cp-temporary-domain) documentation.","required":"false","name":"domain","in":"query"},{"in":"query","name":"bwlimit","required":"false","description":"The account's maximum bandwidth.\n* `0`, `unlimited`, or `null` — The account possesses unlimited bandwidth.","schema":{"oneOf":[{"enum":["null"]},{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}],"example":"unlimited","format":"megabytes"}},{"description":"Whether the account has [Common Gateway Interface (CGI)](https://en.wikipedia.org/wiki/Common_Gateway_Interface) access enabled.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\n When a [server profile](https://docs.cpanel.net/whm/server-configuration/server-profile/) disables the [Web Server](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/86/) role, this parameter defaults to `0`. On these servers, you **cannot** enable CGI access.","schema":{"enum":["1","0"],"example":"1","default":"1","type":"integer"},"name":"cgi","in":"query","required":"false"},{"required":"false","name":"contactemail","in":"query","schema":{"format":"email","default":"","example":"username@example.com","type":"string"},"description":"The account's contact email address."},{"description":"The account's cPanel theme.\n\n**Note:**\n\nThis parameter defaults to the server's [default cPanel theme](https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/).","schema":{"type":"string","example":"jupiter"},"name":"cpmod","in":"query","required":"false"},{"required":"false","in":"query","name":"customip","schema":{"format":"ipv4","example":"192.0.2.0","type":"string"},"description":"The account's IP address.\n\n**Note:**\n\nIf you do not specify this parameter, the system will determine the account's IP address."},{"required":"false","in":"query","name":"dkim","schema":{"type":"integer","example":"1","enum":["0","1"]},"description":"Whether [DomainKeys Identified Mail (DKIM)](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail) is enabled for the account.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nThis parameter defaults to the *Enable DKIM on domains for newly created accounts* setting's value in WHM's *[Tweak Settings](https://docs.cpanel.net/whm/server-configuration/tweak-settings/) interface (WHM >> Home >> System Configuration >> Tweak Settings)*."},{"schema":{"enum":["0","1"],"example":"1","type":"integer"},"description":"Whether [Domain-based Message Authentication, Reporting, and Conformance (DMARC)](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary/#dmarc) is enabled for the account.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Note:**\n\nThis parameter defaults to the *Enable DMARC on domains for newly created accounts* setting's value in the _Domains_ section of WHM's *[Tweak Settings](https://docs.cpanel.net/whm/server-configuration/tweak-settings/#domains) interface (WHM >> Home >> System Configuration >> Tweak Settings)*.","required":"false","in":"query","name":"dmarc"},{"required":"false","name":"featurelist","in":"query","schema":{"type":"string","default":"default","example":"feature_list"},"description":"The account's assigned feature list."},{"in":"query","name":"forcedns","required":"false","description":"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.\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.","schema":{"type":"integer","default":"0","example":"0","enum":["0","1"]}},{"required":"false","in":"query","name":"frontpage","description":"Whether the account has Microsoft® FrontPage Extensions enabled.\n\n**Note:**\n\n cPanel & WHM ignores all FrontPage settings and parameters.","deprecated":"true","schema":{"nullable":"true","default":null,"type":"integer"}},{"description":"The account's group ID.\n\n**Note:**\n\n* To use this parameter, the function's caller **must** authenticate as the root user.\n* If you do **not** specify this parameter, the system generates a group ID.\n* This **must** be a unique value that is **not** currently associated with disk usage and does **not** exist on the server.","schema":{"example":"123456789","minimum":"1","type":"integer"},"in":"query","name":"gid","required":"false"},{"name":"hasshell","in":"query","required":"false","description":"Whether the account has shell (SSH) access enabled.\n* `1` — Enabled.\n* `0` — Disabled.","schema":{"enum":["0","1"],"example":"0","default":"0","type":"integer"}},{"schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"},"description":"A legacy parameter.\n* `1` — Enabled.\n* `0` — Disabled.\n\n**Important:**\n\n Only include this parameter if you set a useregns value of 1.","required":"false","name":"hasuseregns","in":"query"},{"in":"query","name":"homedir","required":"false","description":"The absolute path to the account's `home` directory.\n\n**Note:**\n\n* To use this parameter, the function's caller **must** authenticate as the `root` user.\n* If you do not specify a value, the system uses the `/home/user` directory, where `user` is the account's username.","schema":{"example":"/home/user","type":"string"}},{"required":"false","name":"ip","in":"query","schema":{"example":"n","enum":["y","n"],"default":"n","type":"string"},"description":"Whether the account has a dedicated IP address.\n* `y` — The account possesses a dedicated IP address.\n* `n` — The account does **not** possess a dedicated IP address."},{"schema":{"example":"en","type":"string"},"description":"The account's default locale.\n\n**Note:**\n\n* This value is case-sensitive.\n* For region-specific locales, use the ISO 639-1 code, an underscore (`_`), and the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) code.","required":"false","in":"query","name":"language"},{"description":"The name of the account owner.\n* `root`\n*  A valid reseller account username on the server.","schema":{"type":"string","example":"root"},"in":"query","name":"owner","required":"false"},{"name":"ownerself","in":"query","required":"false","description":"Set the account to own itself. Ignored if `owner` is set.\n* `1` — Set account to own itself.\n* `0` — Do nothing.","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]}},{"description":"A [linked cPanel mail server](https://docs.cpanel.net/whm/server-configuration/link-server-nodes/) 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.\n\n**Note:**\n\n This function **requires** a linked cPanel mail server.","schema":{"type":"string","example":"mailnode"},"name":"mail_node_alias","in":"query","required":"false"},{"schema":{"type":"string","enum":["mdbox","maildir"],"example":"mdbox"},"description":"A mailbox format to use, if you do not wish to use the system's default mailbox format.\n\n**Note:**\n\n* Use this parameter when you transfer between servers with different mailbox formats.\n* This parameter defaults to the *The mailbox storage format for new accounts setting* in the *Mail* section of WHM's [*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/#mail) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).","required":"false","name":"mailbox_format","in":"query"},{"schema":{"example":"unlimited","default":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":"0","type":"integer"}]},"description":"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.\n* `0` or `unlimited` — The account can send an unlimited number of failed or deferred messages.","required":"false","name":"max_defer_fail_percentage","in":"query"},{"required":"false","name":"max_email_per_hour","in":"query","schema":{"example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"type":"integer","minimum":"0"}]},"description":"The maximum number of emails that the account can send in one hour.\n* `0` or `unlimited` — The account can send an unlimited number of emails."},{"in":"query","name":"max_emailacct_quota","schema":{"example":"1024","format":"megabytes","default":"1024","oneOf":[{"type":"string","enum":["unlimited"]},{"maximum":"4294967296","type":"integer","minimum":"0"}]},"description":"The maximum size that the account can define when it creates an email account.\n* `0` or `unlimited` — The account possesses an unlimited quota.\n\n**Important:**\n\n * This value applies to each email account, **not** each cPanel account.\n * If you define this parameter it overwrites the hosting plan's defined value for the account.\n * We recommend that you allow the account's plan to determine this value."},{"name":"maxaddon","in":"query","required":"false","description":"The account's maximum number of addon domains.\n* `unlimited`, or `null` — The account possesses unlimited addon domains.","schema":{"example":"unlimited","default":"0","oneOf":[{"enum":["null"]},{"enum":["unlimited"],"type":"string"},{"maximum":"999999","type":"integer","minimum":"0"}]}},{"description":"The account's maximum number of FTP accounts.\n* `0`, `unlimited`, or `null` — The account possesses unlimited FTP accounts.","schema":{"oneOf":[{"enum":["null"]},{"type":"string","enum":["unlimited"]},{"type":"integer","maximum":"999999","minimum":"0"}],"example":"unlimited"},"in":"query","name":"maxftp","required":"false"},{"required":"false","name":"maxlst","in":"query","schema":{"oneOf":[{"enum":["null"]},{"type":"string","enum":["unlimited"]},{"minimum":"0","type":"integer","maximum":"999999"}],"example":"unlimited"},"description":"The account's maximum number of mailing lists.\n* `0`, `unlimited`, or `null` — The account possesses unlimited mailing lists."},{"name":"maxpark","in":"query","required":"false","description":"The account's maximum number of parked domains (aliases).\n* `unlimited` or `null` — The account possesses unlimited parked domains.","schema":{"oneOf":[{"enum":["null"]},{"enum":["unlimited"],"type":"string"},{"type":"integer","maximum":"999999","minimum":"0"}],"default":"0","example":"unlimited"}},{"required":"false","name":"maxpop","in":"query","schema":{"example":"unlimited","oneOf":[{"enum":["null"]},{"type":"string","enum":["unlimited"]},{"type":"integer","maximum":"999999","minimum":"0"}]},"description":"The account's maximum number of email accounts.\n* `0`, `unlimited`, or `null` — The account possesses unlimited email accounts."},{"name":"maxsql","in":"query","required":"false","description":"The account's maximum number of each available type of SQL database.\nFor example, this parameter has a `5` value and the system administrator allows\nMySQL® and PostgreSQL® databases. Users can create up to five MySQL databases\nand up to five PostgreSQL databases.\n* `0`, `unlimited`, or `null` — The account possesses unlimited databases.","schema":{"example":"unlimited","oneOf":[{"enum":["null"]},{"type":"string","enum":["unlimited"]},{"minimum":"0","maximum":"999999","type":"integer"}]}},{"description":"The account's maximum number of subdomains.\n`unlimited` or `null` — The account possesses unlimited subdomains.","schema":{"oneOf":[{"enum":["null"]},{"type":"string","enum":["unlimited"]},{"type":"integer","maximum":"999999","minimum":"0"}],"example":"unlimited"},"in":"query","name":"maxsub","required":"false"},{"description":"The account's main mail exchanger's type.\n* `local` - Local Mail Exchanger.\n* `secondary` - Backup Mail Exchanger.\n* `remote` - Remote Mail Exchanger.\n* `auto` - Automatically Detect Configuration.\n\n**Note:**\n\nThe function does **not** configure the primary MX entry to point to the appropriate exchanger. You must [perform this function separately](https://docs.cpanel.net/whm/dns-functions/email-routing-configuration/).","schema":{"example":"auto","enum":["local","secondary","remote","auto"],"default":"local","type":"string"},"name":"mxcheck","in":"query","required":"false"},{"name":"pass","in":"query","required":"false","description":"The account's password.\n\n**Note:**\n\n * You can use either the `pass` or the `password` parameter, but **not** both.\n * If you don't specify this value, the system generates a secure password.","schema":{"type":"string","example":"123456luggage"}},{"required":"false","in":"query","name":"password","schema":{"type":"string","example":"123456luggage"},"description":"The account's password.\n\n**Note:**\n\n * You can use **either** the `pass` or the `password` parameter, but **not** both.\n * If you don't specify this value, the system generates a secure password."},{"in":"query","name":"pkgname","required":"false","description":"A new plan name. Use this parameter to save unique account settings as a new plan.\n\n**Note:**\n\n * If you do **not** use this parameter but specify `1` for the `savepkg` value, the system will generate a plan name.\n * If you do **not** use this parameter and specify `0` or do not use the `savepkg` parameter, the function does not save a new plan.\n * If you do **not** use this parameter, the function will not save the new account settings.","schema":{"example":"my_new_package","type":"string"}},{"description":"The account's hosting plan (package).\n\n**Important:**\n\n If you provide this value, **do not** use the optional quota-related parameters below. Instead, we recommend that you allow the account's plan to determine these values.","schema":{"example":"default","default":"default","type":"string"},"name":"plan","in":"query","required":"false"},{"name":"quota","in":"query","required":"false","description":"The account's disk space quota.\n* `0` — The account's disk space is unlimited.","schema":{"default":"0","format":"megabytes","example":"500","type":"integer","maximum":"999999","minimum":"0"}},{"description":"Whether to grant reseller privileges to the account.\n* `1` — Grant reseller privileges.\n* `0` — Do **not** grant reseller privileges.","schema":{"type":"integer","example":"0","enum":["0","1"],"default":"0"},"in":"query","name":"reseller","required":"false"},{"schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"description":"Whether to save the account's settings as a new plan.\n* `1` — Save.\n* `0` — Do **not** save.","required":"false","in":"query","name":"savepkg"},{"required":"false","name":"spamassassin","in":"query","schema":{"example":"1","enum":["0","1"],"default":"1","type":"integer"},"description":"Whether the account has Apache SpamAssassin™ enabled.\n* `1` — Enabled.\n* `0` — Disabled."},{"in":"query","name":"spf","required":"false","description":"Whether [Sender Policy Framework (SPF)](https://en.wikipedia.org/wiki/Sender_Policy_Framework) is enabled for the account.\n* `1` — Enabled.\n* `0` — Disabled.\n\nThis parameter defaults to the *Enable SPF on domains for newly created accounts*\nsetting's value in WHM's [*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/) interface (*WHM >> Home >> System Configuration >> Tweak Settings*).","schema":{"enum":["0","1"],"example":"1","type":"integer"}},{"description":"Whether to enable spam box filtering for the account.\n* `y` - Enable spam box filtering.\n* `n` - Disable spam box filtering.\n**Note:**\n\n You **must** enable Apache SpamAssassin™ to use the Spam Box feature.","schema":{"type":"string","example":"y","enum":["y","n"],"default":"y"},"in":"query","name":"spambox","required":"false"},{"description":"The account's user ID.\n\n**Note:**\n\n * To use this parameter, the function's caller **must** authenticate as the `root` user.\n * If you do not specify this parameter, the system generates a user ID.\n * This **must** be a unique value that is **not** currently associated with disk usage and does **not** exist on the server.","schema":{"minimum":"0","type":"integer","example":"123456789"},"name":"uid","in":"query","required":"false"},{"schema":{"type":"integer","enum":["0","1"],"example":"0","default":"0"},"description":"Whether to use registered nameservers for the domain.\n* `1` - Use registered nameservers.\n* `0` - Use the server's default nameservers.\n\n**Important:**\n\n If you set this parameter to `1`, you must also include the `hasuseregns` parameter with a value of `1`.","required":"false","in":"query","name":"useregns"},{"schema":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"examples":{"single":{"summary":"Assign one enhancement","value":"My Custom Enhancement"},"multiple":{"value":["My Custom Enhancement","Sample Enhancement"],"summary":"Assign multiple enhancements"}},"description":"Assign [Account Enhancements](https://go.cpanel.net/account-enhancements) to the cPanel account. To view your server's Account Enhancements, run WHM API 1's `list_account_enhancements` function.","in":"query","name":"account_enhancements"},{"schema":{"type":"integer","example":"0","enum":["0","1"],"default":"0"},"description":"Create the user as a reseller without an associated domain.\n* `1` - Create the account as a reseller without an associated domain.\n* `0` - Do **not** create the account as a reseller without an associated domain.\n\n**Warning:**\n\nIf you create a reseller without a domain, certain parts of WHM will not function\nfor that user. These limitations exist both when logged in as that user **and**\nwhen you attempt to perform actions which affect that user.","required":"false","in":"query","name":"reseller_without_domain"},{"required":"false","in":"query","name":"max_team_users","schema":{"minimum":"0","type":"integer","maximum":"7","example":"7"},"description":"The maximum number of Team users for this account.\nThis parameter should be a number between 0 and the server's default value, inclusively.\nThis parameter can not be a number greater than the server's default value."},{"in":"query","name":"showpass","required":"false","description":"Whether to display the account password in the output.\n* `y` — Display the account password in the output.\n* `n` — Do NOT display the account password in the output.","schema":{"example":"n","enum":["y","n"],"default":"y","type":"string"}}]}}},"tags":[{"description":"Accounts / Account Creation","name":"Account Creation"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}}}]},"listipv6s":{"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"tags":[{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"description":"IP Address Management / IPv6 Address Settings","name":"IPv6 Address Settings"}],"paths":{"/listipv6s":{"get":{"parameters":[],"operationId":"listipv6s","description":"This function lists the IPv6 addresses bound to a server’s network interfaces.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"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"}}},"data":{"type":"object","properties":{"ip":{"description":"An array of objects that contain IPv6 address information.","items":{"properties":{"ip":{"description":"The IPv6 address.","format":"ipv6","example":"2001:0db8:0:0:1:0:0:1","type":"string"}}},"type":"array"}}}},"type":"object"}}}}},"x-cpanel-available-version":"11","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  listipv6s\n"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/listipv6s?api.version=1","lang":"HTTP","label":"URL"}],"x-cpanel-api-version":"WHM API 1","summary":"Return server's IPv6 addresses"}}},"x-tagGroups":[{"tags":["IPv6 Address Settings"],"name":"IP Address Management"}]},"backup_get_transport_status":{"x-tagGroups":[{"tags":["Backup or Restore"],"name":"Backups"}],"paths":{"/backup_get_transport_status":{"get":{"tags":["Backups","Backup or Restore"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  backup_get_transport_status\n","label":"CLI","lang":"Shell"},{"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","summary":"Return backup transport events' 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.","schema":{"type":"string","example":"transportname"},"name":"transport_id","in":"query","required":"false"},{"schema":{"example":"running","enum":["completed","failed","pending","running"],"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`","required":"false","in":"query","name":"state"}],"operationId":"backup_get_transport_status","description":"This function retrieves the status of any backup transport events on the account.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"transport_status":{"items":{"properties":{"date":{"example":"2019-08-30T00:00:00.000Z","description":"The backup transport event's date.","format":"ISO-8601 Date","type":"string"},"end_timestamp":{"example":"2019-08-30T02:04:06.000Z","description":"The transport event's end time, in `YYYY-MM-DD HH:MM:SS` format.","type":"string"},"start_timestamp":{"example":"2019-08-30T02:04:08.000Z","description":"The transport event's start time, in `YYYY-MM-DD HH:MM:SS` format.","type":"string"},"status":{"type":"string","example":"running","description":"The transport event's status.\n\n* `completed`\n* `failed`\n* `pending`\n* `running`"},"transport":{"type":"string","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"},"user":{"type":"string","description":"The user for whom the system transported the backup.","example":"username"}}},"description":"A list of information about each transport event.","type":"array"},"pages":{"type":"integer","example":"3","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."}},"type":"object"},"metadata":{"properties":{"command":{"type":"string","example":"backup_get_transport_status","description":"The method name called."},"version":{"example":"1","description":"The API version of the function.","type":"integer"},"result":{"description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"],"type":"integer"},"reason":{"type":"string","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"}}}}}}}}},"x-cpanel-available-version":"78"}}},"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"name":"Backup or Restore","description":"Backups / Backup or Restore"}],"servers":[{"variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"version":"88","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2"},"modsec_check_rule":{"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"title":"WHM API"},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"tags":[{"name":"ModSecurity","description":"The ModSecurity module for WHM API 1."},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}],"x-tagGroups":[{"tags":["Rule Settings"],"name":"Web Server Security (ModSecurity)"}],"paths":{"/modsec_check_rule":{"get":{"responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"reason":{"example":"OK Invalid Rule","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["1","0"],"example":"1","type":"integer"},"command":{"description":"The method name called.","example":"modsec_check_rule","type":"string"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}},"data":{"properties":{"problem":{"type":"string","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'","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."},"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"}}}}}}},"x-cpanel-available-version":"11.46","parameters":[{"required":"true","name":"rule","in":"query","schema":{"example":"SecAction \"pass,id:1234567\"","type":"string"},"description":"The ModSecurity rule to check."}],"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","x-cpanel-api-version":"WHM API 1","summary":"Validate ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  modsec_check_rule \\\n  rule='SecAction \"pass,id:1234567\"'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_check_rule?api.version=1&rule=SecAction%20%22pass%2cid%3a1234567%22","lang":"HTTP","label":"URL"}]}}}},"set_tweaksetting":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"Server Administration / Configurations","name":"Configurations"}],"paths":{"/set_tweaksetting":{"get":{"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*).","schema":{"type":"string","example":"proxysubdomains"},"in":"query","name":"key","required":"true"},{"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`","schema":{"example":"Main","enum":["Apache","Basic","Mail","Main"],"default":"Main","type":"string"},"in":"query","name":"module","required":"false"},{"schema":{"type":"string","example":"0"},"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.","required":"false","in":"query","name":"value"}],"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","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":["0","1"],"example":"1"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"command":{"example":"set_tweaksetting","description":"The method name called.","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}}}},"x-cpanel-available-version":"11","tags":["Configurations"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_tweaksetting \\\n  key='proxysubdomains'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_tweaksetting?api.version=1&key=proxysubdomains","label":"URL","lang":"HTTP"}],"x-cpanel-api-version":"WHM API 1","summary":"Update Tweak Settings option"}}},"x-tagGroups":[{"tags":["Configurations"],"name":"Server Administration"}]},"set_enhancement_limit":{"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.97.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"}},"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}},"schemas":{}},"x-tagGroups":[{"tags":["Account Enhancement Limit"],"name":"Resellers"}],"paths":{"/set_enhancement_limit":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_enhancement_limit \\\n  account='username' \\\n  id='sample-enhancement-id' \\\n  limited='1' \\\n  limit='15'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/set_enhancement_limit?api.version=1&account=username&id=sample-enhancement-id&limited=1&limit=15","lang":"HTTP","label":"URL"}],"tags":["Resellers","Account Enhancement Limit","Account Enhancement","Account Limit"],"summary":"Update account enhancement limit","x-cpanel-api-version":"WHM API 1","operationId":"set_enhancement_limit","description":"This function sets account enhancement limits for a reseller account.","parameters":[{"required":"true","in":"query","name":"account","schema":{"type":"string","example":"username","format":"username"},"description":"The reseller's username."},{"description":"The account enhancement's identifier.\n\n**Note:**\n* You must use an [account enhancement](https://go.cpanel.net/account-enhancements) ID that a 3rd-party plugin defines.\n* To return a list of valid account enhancement IDs, run the WHM API 1 `list_account_enhancements` function.","schema":{"example":"sample-enhancement-id","type":"string"},"name":"id","in":"query","required":"true"},{"description":"Whether the Account Enhancement assignment limit is unlimited.\n* `0` - The assignment is unlimited.\n* `1` - The assignment is limited.","schema":{"type":"integer","example":"1","enum":["1","0"]},"in":"query","name":"limited","required":"true"},{"description":"The account enhancement limit amount. This parameter is only\nrequired if the `limited` parameter is `1`.","schema":{"type":"integer","example":"15"},"name":"limit","in":"query"}],"x-cpanel-available-version":"11.98","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","description":"The method name called.","example":"set_enhancement_limit"},"result":{"type":"integer","example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details."},"reason":{"example":"OK","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.","type":"string"}}}},"type":"object"}}}}}}}},"tags":[{"name":"Resellers","description":"The Resellers module for WHM API 1."},{"name":"Account Enhancement Limit","description":"Resellers / Account Enhancement Limit"}],"servers":[{"description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"url":"https://{host}:{port}/json-api"}]},"get_featurelists_by_package_types":{"tags":[{"name":"Packages","description":"The Packages module for WHM API 1."},{"description":"Hosting Plans / Feature Lists","name":"Feature Lists"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Hosting Plans","tags":["Feature Lists"]}],"paths":{"/get_featurelists_by_package_types":{"get":{"x-cpanel-available-version":"11","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","properties":{"package_types_feature_lists":{"description":"An object that contains package types as keys and arrays of feature list names as values.","properties":{"nova":{"type":"array","description":"An array of feature list names associated with this package type.","items":{"type":"string"}},"standard":{"type":"array","description":"An array of feature list names associated with this package type.","items":{"type":"string"}}},"required":["standard"],"type":"object"}},"example":{"package_types_feature_lists":{"standard":["Mail Only","default","disabled","basic_plan"],"nova":["__default_nova","nova_custom"]}}},"metadata":{"properties":{"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["1","0"]},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"command":{"type":"string","example":"get_featurelists_by_package_types","description":"The method name called."},"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"}}}},"type":"object"}}}}},"operationId":"get_featurelists_by_package_types","description":"This function lists features grouped by package type.","parameters":[],"x-cpanel-api-version":"WHM API 1","summary":"Return feature lists by package type","tags":["Packages","Feature Lists"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  get_featurelists_by_package_types\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/get_featurelists_by_package_types?api.version=1","label":"URL","lang":"HTTP"}]}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.131.0.9999","description":"WHM API.","title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"}}},"unstage_services_cluster_node":{"tags":[{"description":"The ServicesCluster module for WHM API 1.","name":"ServicesCluster"},{"description":"ServicesCluster","name":"ServicesCluster"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"x-tagGroups":[{"tags":["ServicesCluster"],"name":"ServicesCluster"}],"paths":{"/unstage_services_cluster_node":{"get":{"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  unstage_services_cluster_node \\\n  name=server2\n"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/unstage_services_cluster_node?name=server2"}],"tags":["ServicesCluster"],"summary":"Remove a staged services cluster node","x-cpanel-api-version":"WHM API 1","operationId":"unstage_services_cluster_node","description":"This function removes a staged Services Cluster node.\n\n**Important:**\n\nThis function **only** runs on a server that has a cPanel cloud license.","x-cpanel-internal-only":"true","parameters":[{"in":"query","name":"name","description":"The staged services cluster node's name.","schema":{"pattern":"^[a-z][a-z0-9]*$","type":"string","example":"server2"}}],"x-cpanel-available-version":"11.110","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"nodes":{"description":"An array of objects containing remaining staged services cluster nodes.","items":{"properties":{"ip_address":{"format":"ipv4","description":"The node's internal IP address.","example":"10.0.1.1","type":"string"},"role":{"example":"server","enum":["server","agent"],"description":"* `server` - The node is acting as a server node in the cluster.\n* `agent` - The node is acting as an agent node in the cluster.","type":"string"},"name":{"type":"string","pattern":"^[a-z][a-z0-9]*$","example":"server1","description":"A friendly name for the node."},"ssh_key":{"type":"string","example":"id_rsa","description":"The name of the SSH key the system uses for authentication during deployment."}}}}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK"},"command":{"type":"string","description":"The method name called.","example":"unstage_services_cluster_node"},"version":{"type":"integer","example":"1","description":"The version of the API function."},"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"]}}}},"type":"object"}}},"description":"HTTP Request was successful."}}}}},"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."}},"set_autossl_metadata":{"x-tagGroups":[{"tags":["Auto-Generated Certificates"],"name":"SSL Certificates"}],"paths":{"/set_autossl_metadata":{"get":{"parameters":[{"in":"query","name":"metadata_json","required":"true","description":"JSON-encoded object of metadata keys and values that control AutoSSL's behavior.","content":{"application/json":{"schema":{"example":{"notify_autossl_expiry_coverage":"1","notify_autossl_renewal_uncovered_domains":"1","notify_autossl_renewal_coverage_user":"1","notify_autossl_expiry_user":"1","notify_autossl_renewal_coverage":"1","notify_autossl_renewal_user":"1","notify_autossl_renewal_uncovered_domains_user":"1","clobber_externally_signed":"1","notify_autossl_renewal_coverage_reduced":"1","notify_autossl_renewal":"1","notify_autossl_expiry_coverage_user":"1","notify_autossl_expiry":"1","notify_autossl_renewal_coverage_reduced_user":"1"},"properties":{"notify_autossl_expiry_coverage":{"type":"integer","description":"Whether to send a notification if at least one currently-secured domain will lose coverage when the certificate renews.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","default":"1","example":"1","enum":["0","1"]},"notify_autossl_renewal_uncovered_domains":{"example":"1","enum":["0","1"],"default":"1","description":"Whether to send a notification when AutoSSL has renewed a certificate and the new certificate lacks one or more of the website’s domains.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","type":"integer"},"notify_autossl_renewal_coverage_user":{"type":"integer","description":"Whether to send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","default":"1","example":"1","enum":["0","1"]},"notify_autossl_expiry_user":{"example":"1","enum":["0","1"],"default":"1","description":"Whether to send a notification when a user's AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate for a user.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","type":"integer"},"notify_autossl_renewal_user":{"enum":["0","1"],"example":"1","default":"1","description":"Whether to send a notification  when AutoSSL successfully renews a certificate for a user.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","type":"integer"},"notify_autossl_renewal_coverage":{"description":"Whether to send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","default":"1","example":"1","enum":["0","1"],"type":"integer"},"notify_autossl_renewal_uncovered_domains_user":{"type":"integer","description":"Whether to send a notification  when AutoSSL has renewed a certificate for a user and the new certificate lacks one or more of the website’s domains.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","default":"1","enum":["0","1"],"example":"1"},"notify_autossl_renewal_coverage_reduced":{"type":"integer","description":"Whether to send a notification when AutoSSL has renewed a certificate and the new certificate lacks at least one domain that the previous certificate secured.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","default":"1","example":"1","enum":["0","1"]},"clobber_externally_signed":{"description":"Whether to allow AutoSSL to replace certificates that none of\nthis system’s AutoSSL modules issued. When you enable this option, AutoSSL\nwill install certificates that replace users’ Certificate Authority (CA)\nissued certificates if they are invalid or expire within three days.\n* `1` - Replace certificates not issued by the AutoSSL system.\n* `0` - Only replace certificates issued by the AutoSSL system.","default":"0","example":"1","enum":["0","1"],"type":"integer"},"notify_autossl_renewal":{"type":"integer","default":"1","description":"Whether to send a notification when AutoSSL successfully renews a certificate.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","example":"1","enum":["0","1"]},"notify_autossl_expiry_coverage_user":{"type":"integer","enum":["0","1"],"example":"1","default":"1","description":"Whether to send a notification if at least one of a user's currently-secured domains will lose coverage when the certificate renews.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification."},"notify_autossl_renewal_coverage_reduced_user":{"example":"1","enum":["0","1"],"description":"Whether to send a notification  when AutoSSL has renewed a certificate for a user and the new certificate lacks at least one domain that the previous certificate secured.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.","default":"1","type":"integer"},"notify_autossl_expiry":{"type":"integer","example":"1","enum":["0","1"],"default":"1","description":"Whether to send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate.\n* `1` - Send a notification.\n* `0` - Do **not** send a notification.\n\n**Notes:**\n\nThis can happen if all of a website’s domains fail Domain Control Validation (DCV), or if the AutoSSL provider has not issued a certificate in response to a request."}},"type":"object"}}}}],"description":"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.\n\n**Note:**\n\nWe recommend that you use the WHM API 1 `set_autossl_metadata_key` function instead.\n\n**Information:**\n\n* You can enter more than one key and value pair in the `metadata_json` JSON hash.\n* Any keys that you do not **explicitly** define will adopt the system's default value.","operationId":"set_autossl_metadata","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"type":"integer","description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","example":"1","enum":["0","1"]},"command":{"type":"string","example":"set_autossl_metadata","description":"The method name called."},"version":{"type":"integer","example":"1","description":"The version of the API function."},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}}}}}}}},"x-cpanel-available-version":"60","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  set_autossl_metadata \\\n  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\"}'\n","lang":"Shell","label":"CLI"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_metadata?api.version=1&metadata_json=%7b%22clobber_externally_signed%22%3a%221%22%2c%22notify_autossl_expiry%22%3a%221%22%2c%22notify_autossl_expiry_coverage%22%3a%221%22%2c%22notify_autossl_expiry_coverage_user%22%3a%221%22%2c%22notify_autossl_expiry_user%22%3a%221%22%2c%22notify_autossl_renewal%22%3a%221%22%2c%22notify_autossl_renewal_coverage%22%3a%221%22%2c%22notify_autossl_renewal_coverage_reduced%22%3a%221%22%2c%22notify_autossl_renewal_coverage_reduced_user%22%3a%221%22%2c%22notify_autossl_renewal_coverage_user%22%3a%221%22%2c%22notify_autossl_renewal_uncovered_domains%22%3a%221%22%2c%22notify_autossl_renewal_uncovered_domains_user%22%3a%221%22%2c%22notify_autossl_renewal_user%22%3a%221%22%7d"}],"tags":["SSL","Auto-Generated Certificates"],"summary":"Update AutoSSL metadata","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"name":"SSL","description":"The SSL module for WHM API 1."},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"}],"servers":[{"variables":{"port":{"default":"2087","description":"The WHM port."},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2"},"activate_zone_key":{"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"openapi":"3.0.2","components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"paths":{"/activate_zone_key":{"get":{"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  activate_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/activate_zone_key?api.version=1&domain=example.com&key_id=1","label":"URL","lang":"HTTP"}],"tags":["DNS","DNS Security"],"summary":"Enable domain's DNSSEC key","x-cpanel-api-version":"WHM API 1","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.","schema":{"example":"example.com","type":"string"},"in":"query","name":"domain","required":"true"},{"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.","schema":{"type":"integer","minimum":"1","example":"1"},"name":"key_id","in":"query","required":"true"}],"x-cpanel-available-version":"86","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"result":{"example":"1","enum":["0","1"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","example":"activate_zone_key","description":"The method name called."},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}}}}}},"description":"HTTP Request was successful."}}}}},"x-tagGroups":[{"tags":["DNS Security"],"name":"DNS"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"name":"DNS Security","description":"DNS / DNS Security"}]},"set_provider_display_configurations":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"info":{"version":"11.89.0.9999","termsOfService":"https://cpanel.net/legal-notices/","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"description":"WHM API.","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/set_provider_display_configurations":{"get":{"parameters":[{"description":"The cPanel & WHM service's name.\n* `cpaneld` — The cPanel daemon.\n* `whostmgrd` — The WHM daemon.\n* `webmaild` — The Webmail daemon.","schema":{"example":"cpaneld","enum":["cpaneld","whostmgrd","webmaild"],"type":"string"},"name":"service_name","in":"query","required":"true"},{"name":"provider_id","in":"query","required":"true","description":"The identity provider's key.","schema":{"example":"cpanelid","type":"string"}},{"description":"The display configuration in JSON-encoded key-value format.","content":{"application/json":{"schema":{"type":"object","properties":{"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":{"type":"string","example":"image/svg+xml","default":"image/svg+xml","format":"mime","description":"The icon file's MIME type."},"textcolor":{"description":"The color of the text label on the cPanel login interface.","format":"RGB","example":"FFFFFF","type":"string"},"label":{"type":"string","example":"Log in with a cPanelID Account","description":"The text label that will appear on the cPanel login interface."},"display_name":{"type":"string","description":"The display name of the identity provider.","example":"cPanel"},"color":{"type":"string","example":"dd4b39","description":"The background color of the button on the cPanel interface.","format":"RGB"}}},"example":{"textcolor":"44ffbb","color":"6677aa","display_name":"Hosting Center Login"}}},"name":"configurations","in":"query","required":"true"}],"operationId":"set_provider_display_configurations","description":"This function sets the display configuration for the login button of an external authentication identity provider.","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"enum":["0","1"],"example":"1","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"command":{"description":"The method name called.","example":"set_provider_display_configurations","type":"string"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds."}}}},"type":"object"}}}}},"x-cpanel-available-version":"54","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"}],"tags":["Authentication","External Authentication"],"summary":"Update identity provider login interface appearance","x-cpanel-api-version":"WHM API 1"}}},"x-tagGroups":[{"name":"Authentication","tags":["External Authentication"]}],"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"name":"External Authentication","description":"Authentication / External Authentication"}]},"has_local_authority":{"x-tagGroups":[{"tags":["Domain Management"],"name":"DNS"}],"paths":{"/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":[{"required":"true","name":"domain","in":"query","schema":{"type":"string"},"examples":{"single":{"summary":"A single domain","value":"example.com"},"multiple":{"value":"domain=example.com domain-1=example1.com domain-2=example2.com","summary":"Multiple domains"}},"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."}],"x-cpanel-available-version":"78","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","description":"The method name called.","example":"has_local_authority"},"version":{"type":"integer","description":"The version of the API function.","example":"1"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","example":"1","enum":["0","1"],"type":"integer"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"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":{"type":"object","properties":{"domain":{"description":"The queried domain.","example":"example.com","type":"string"},"error":{"example":"(XID qdbmuk) DNS query (example3.com/SOA) timeout!","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.","type":"string"},"nameservers":{"description":"The domain's authoritative nameservers, if any exist.","items":{"type":"string","format":"domain"},"example":["ns1.example.com","ns2.example.com"],"type":"array"},"zone":{"nullable":"true","example":"example.com","format":"domain","description":"The DNS zone that contains the domain's DNS records, if one exists.","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"}}},"type":"array"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  has_local_authority \\\n  domain='example.com'\n","label":"CLI","lang":"Shell"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/has_local_authority?api.version=1&domain=example.com","lang":"HTTP","label":"URL"}],"tags":["DNS","Domain Management"],"summary":"Validate local server is authoritative","x-cpanel-api-version":"WHM API 1"}}},"tags":[{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / Domain Management","name":"Domain Management"}],"servers":[{"url":"https://{host}:{port}/json-api","description":"A server running WHM.","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","termsOfService":"https://cpanel.net/legal-notices/","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"version":"11.89.0.9999","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"title":"WHM API"},"openapi":"3.0.2","components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"backup_destination_add":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"openapi":"3.0.2","info":{"title":"WHM API","contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"servers":[{"variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."}},"description":"A server running WHM.","url":"https://{host}:{port}/json-api"}],"tags":[{"name":"Backups","description":"The Backups module for WHM API 1."},{"description":"Backups / Backup Destination","name":"Backup Destination"}],"paths":{"/backup_destination_add":{"get":{"x-codeSamples":[{"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","lang":"Shell","label":"CLI"},{"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"}],"tags":["Backups","Backup Destination"],"summary":"Add a backup destination","x-cpanel-api-version":"WHM API 1","parameters":[{"required":"true","in":"query","name":"name","schema":{"example":"destination_name","type":"string"},"description":"The backup destination's name."},{"schema":{"example":"Local","enum":["Custom","FTP","Local","SFTP","WebDAV","AmazonS3","Rsync","GoogleDrive","S3Compatible","Backblaze"],"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","required":"true","in":"query","name":"type"},{"required":"true","in":"query","name":"disabled","schema":{"example":"0","enum":["0","1"],"type":"integer"},"description":"Whether to disable the backup destination.\n\n* `1` — Disable the backup destination.\n* `0` — Enable the backup destination."},{"description":"Whether to upload system backups.\n\n* `1` — Upload system backups.\n* `0` — Do **not** upload system backups.","schema":{"type":"integer","enum":["0","1"],"example":"1","default":"0"},"in":"query","name":"upload_system_backup","required":"false"},{"required":"false","in":"query","name":"only_used_for_logs","schema":{"type":"integer","default":"0","example":"1","enum":["0","1"]},"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"},{"required":"false","in":"query","name":"timeout","schema":{"type":"integer","example":"30"},"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."},{"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`","schema":{"type":"string","default":"","example":"subfolder"},"name":"folder","in":"query","required":"false"},{"schema":{"example":"ChockFullOfNuts","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`","required":"true","name":"bucket","in":"query"},{"in":"query","name":"aws_access_key_id","required":"true","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`","schema":{"type":"string","example":"AKIAYLWMPOZZJCERC28Q"}},{"required":"true","name":"password","in":"query","schema":{"type":"string","example":"123456luggage"},"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`"},{"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`","schema":{"default":null,"example":"backups","type":"string"},"in":"query","name":"path","required":"false"},{"required":"true","name":"application_key","in":"query","schema":{"type":"string","example":"A123b45CD678e9"},"description":"The application key's name.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type."},{"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.","schema":{"type":"string","example":"12a345B678c9"},"name":"application_key_id","in":"query","required":"true"},{"in":"query","name":"bucket_id","required":"true","description":"The bucket's ID string.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type.","schema":{"type":"string","example":"a12b34cd5678e9f"}},{"in":"query","name":"bucket_name","required":"true","description":"The bucket's name.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type.","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.","schema":{"type":"string","example":"/home/backups/beammeupscotty.pl"},"in":"query","name":"script","required":"true"},{"schema":{"type":"string","example":"backups.example.com","format":"hostname"},"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`","required":"true","name":"host","in":"query"},{"name":"username","in":"query","required":"true","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`","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`","schema":{"maximum":"65535","type":"integer","minimum":"1","example":"21"},"name":"port","in":"query","required":"false"},{"required":"false","name":"passive","in":"query","schema":{"type":"integer","example":"1","enum":["0","1"],"default":"0"},"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."},{"schema":{"example":"aBcdeFgHIjK123","type":"string"},"description":"The Google Drive client ID.\n\n**Note:**\n\nThis parameter is only valid for the `GoogleDrive` backup type.","required":"true","in":"query","name":"client_id"},{"name":"client_secret","in":"query","required":"true","description":"The Google Drive client secret.\n\n**Note:**\n\nThis parameter is only valid for the `GoogleDrive` backup type.","schema":{"example":"aBcde123FgHIjK456","type":"string"}},{"required":"false","name":"mount","in":"query","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"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."},{"required":"false","name":"no_mount_fail","in":"query","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."},{"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`","schema":{"type":"string","enum":["password","key"],"example":"password"},"name":"authtype","in":"query","required":"true"},{"in":"query","name":"privatekey","required":"false","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`","schema":{"example":"/home/backups/key","default":null,"type":"string"}},{"name":"passphrase","in":"query","required":"false","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`","schema":{"example":"123456luggage","default":null,"type":"string"}},{"required":"false","in":"query","name":"ssl","schema":{"type":"integer","default":"0","enum":["0","1"],"example":"1"},"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."}],"operationId":"backup_destination_add","description":"This function adds a backup destination.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"command":{"type":"string","example":"backup_destination_add","description":"The method name called."},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"result":{"type":"integer","enum":["0","1"],"example":"1","description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details."},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"}}},"data":{"type":"object","properties":{"id":{"description":"The backup destination's ID.","example":"PhAxIoLSdIkCI40q9vWS4BYy","type":"string"}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"11.38"}}},"x-tagGroups":[{"name":"Backups","tags":["Backup Destination"]}]},"enqueue_deferred_ssl_installations":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"name":"WebPros International, LLC","url":"https://cpanel.net/support/","email":"cs@cpanel.net"},"title":"WHM API","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","version":"11.89.0.9999","description":"WHM API."},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"openapi":"3.0.2","paths":{"/enqueue_deferred_ssl_installations":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"},"metadata":{"properties":{"result":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","type":"integer"},"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"type":"string","example":"enqueue_deferred_ssl_installations","description":"The method name called."},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","type":"string"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"88","parameters":[{"required":"true","in":"query","name":"username","schema":{"type":"string"},"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-alternative":{"value":"username=username1 username=username2 username=username3","summary":"Enqueue multiple SSL certificate installations."},"multiple":{"summary":"Enqueue multiple SSL certificate installations.","value":"username-1=username1 username-2=username2 username-3=username3"},"single":{"value":"username","summary":"Enqueue a single SSL certificate installation."}}},{"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":{"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-----","summary":"Enqueue multiple CA bundles."},"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":{"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-----","summary":"Enqueue a single CA bundle."}},"schema":{"type":"string"},"name":"cab","in":"query","required":"true"},{"required":"true","in":"query","name":"crt","schema":{"type":"string"},"examples":{"multiple-alternative":{"summary":"Enqueue the contents of multiple certificates.","value":"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-----"},"multiple":{"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-----","summary":"Enqueue the contents of multiple certificates."},"single":{"summary":"Enqueue a single certificate's contents.","value":"-----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-----"}},"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`."},{"description":"The private key's text.\n\n**Note:**\n\nTo add multiple certificates to the installation queue, duplicate or increment the\nparameter name. For example, `key-1`, `key-2`, and `key-2`.","examples":{"single":{"summary":"Enqueue a single certificate's private key text.","value":"-----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-----"},"multiple":{"value":"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-----","summary":"Enqueue the private key text of multiple certificates."},"multiple-alternative":{"value":"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-----","summary":"Enqueue the private key text of multiple certificates."}},"schema":{"type":"string"},"in":"query","name":"key","required":"true"},{"in":"query","name":"vhost_name","required":"true","description":"The name of the web virtual host (vhost) for which to install the certificate.\n\n**Note:**\n\n To add multiple certificates to the installation queue, duplicate or increment the\n parameter name. For example, `vhost_name-1`, `vhost_name-2`, and `vhost_name-3`.","examples":{"multiple":{"summary":"Install the certificate for multiple vhosts.","value":"vhost_name-1=host1.example.com vhost_name-2=host2.example.com vhost_name-3=host3.example.com"},"multiple-alternative":{"summary":"Install the certificate for multiple vhosts.","value":"vhost_name=host1.example.com vhost_name=host2.example.com vhost_name=host3.example.com"},"single":{"summary":"Install the certificate for a single vhost.","value":"host.example.com"}},"schema":{"type":"string","format":"domain"}}],"operationId":"enqueue_deferred_ssl_installations","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.","summary":"Add SSL certificate to installation queue","x-cpanel-api-version":"WHM API 1","x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  enqueue_deferred_ssl_installations \\\n  username='username' \\\n  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-----' \\\n  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-----' \\\n  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-----' \\\n  vhost_name='host.example.com'\n","label":"CLI","lang":"Shell"},{"lang":"HTTP","label":"URL","source":"https://hostname.example.com:2087/cpsess##########/json-api/enqueue_deferred_ssl_installations?api.version=1&username=username&cab=-----BEGIN%2520CERTIFICATE-----%250AMIIB%2bjCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%250AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%250Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%250AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%250AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k%2b625h8cXyv%250ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz%2biCWaEVh43KRuH6X4M%250AypqfpX%2f1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt%2f5%250A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%250AdcZfHeFhVYAA1IFLezEPI2PnPfMD%2bfQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%250AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4%2f5ODFlitppK%2bULdjG%2bBqXH%2f9Apy%250AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%250A-----END%2520CERTIFICATE-----&crt=-----BEGIN%2520CERTIFICATE-----%250AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%250AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%250AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%250AggEBALer6vzwFt%252BO6ooHcXpq%252Bi%252FOVVQEY3oWxrqH6mB%252FPssVSxwcf6bLjoO4so%252Fn%250Adrymhb9mqfkOqYVHwnQ%252Fh2uM%252BIw1NKKDfwOljWcgCS24NykbfQUlW%252FSNDTovdDGl%250AT1Aner090Qse%252B19ta8KS%252F3Akz37bkgqMkPO%252FiEOHlF%252FLbLvjfighkoGco51wc6d7%250AHCQwPWR%252BUenbQWzUwR4%252F4Pqw%252FYrxDAv8O%252FEnNfOGwnCnlnFq4a390VGriqMAngzI%250AlRMVDu4qJGW3dFNStVUm71%252B16ba%252FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%250AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%250AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%250ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%250AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%252FBwM%250AfJEvlPO30%252FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%252FB36joYDrOhtiO6XsRw4Zm%250AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%252F0rQp1YPsVN9tBgiag754HPo%250AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%250A52gKM0u2%252BrK%252FzIYjh%252FhooqN%252BTY%252BJQ667JzLzPNenzAYFsoIQgVj6%252FZoFqJA4nbxC%250Azv%252Fspqc0OQ2W9m5egRPDhngKt%252Bi9804N7FeilBL%252FcpEgUHhgzMBi1T9n%252BYBrc6bO%250AjNjvnEQRbqZY%250A-----END%2520CERTIFICATE-----&key=-----BEGIN%2520RSA%2520PRIVATE%2520KEY-----%250AMIIEowIBAAKCAQEAt6vq%252FPAW347qigdxemr6L85VVARjehbGuofqYH8%252ByxVLHBx%252F%250ApsuOg7iyj%252Bd2vKaFv2ap%252BQ6phUfCdD%252BHa4z4jDU0ooN%252FA6WNZyAJLbg3KRt9BSVb%250A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%252FcCTPftuSCoyQ87%252BIQ4eUX8tsu%252BN%252BKCGS%250AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%252Fg%252BrD9ivEMC%252Fw78Sc184bCcKeWcWrhrf3R%250AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%250A55rS1ItHF10V3sDRAxBG%252B2eqhS%252FpFkGF5%252Bva3QIDAQABAoIBAAONBE79iUOrLKec%250AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%252FXiqM32%252By1xwRyC3gW%252Fj%250A5odSw19ai%252Fj0V9lHMxOiT%252BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%252BM%250ArfmKDKTkM8%252BWZhsAQe8kSN8NPL3pIJnG%252Ftuc8lwFoZOEot6%252BAeGYdxxEdFbvVyEm%250Aa8%252FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%252B6TMA%250AF7kJsOFiw%252B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%250A6EH%252FCxUCgYEA5qSo6zf6yJ5tdwm%252FNnrKwvFksapd%252Bi9%252BnAqQHHTFPtlzKHkZ7d5x%250AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%252FsAILTcu8QyPzN%250A%252FcYVHWykmFuS55uEa2Mlv6j%252FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%250AlmTy4ka991Ungy%252BVcNTSw9z50l%252Fzu4GxmAlj1fsuX%252F27nbfpsOFjbvlm4xLfW3qM%250A%252BWkrvKXUuxeIbGcBnVlHFWgc6%252BKt5vNoOzUVsm5i90R%252Fg3vhB5cdvuVoTKf2EU4n%250ANVTSaM%252F6zpzBEHSKtTsbx0FiPjS04bk%252Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%250AF%252FPOppV1PaESkCWG76lfL4%252FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%250AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%250AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%250AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%252F%252BUI8P4rdVXrIGHANTAjZl2bt4S51%250Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%252BJq5sjiQ7AoNs7mpvYxqs%250A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%252F%252BypxgH5EnwVr%252B3fF49tfC5xpV9Odfu1Z%250ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%252BM6rc86CmZf%252BvAPTN3%252BJwG%252BcIE%250AcKuYkroIzFWDu9NYiioUI7%252Fa9XdmTvfrT3RSHmup0FoRmlRHD%252FM8%250A-----END%2520RSA%2520PRIVATE%2520KEY-----&vhost_name=host.example.com"}],"tags":["SSL","cPanel Account Settings"]}}},"x-tagGroups":[{"name":"SSL Certificates","tags":["cPanel Account Settings"]}],"servers":[{"description":"A server running WHM.","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"}]},"get_market_providers_product_metadata":{"servers":[{"description":"A server running WHM.","variables":{"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"},"port":{"default":"2087","description":"The WHM port."}},"url":"https://{host}:{port}/json-api"}],"tags":[{"description":"The Market module for WHM API 1.","name":"Market"},{"name":"Product Management","description":"cPanel Market / Product Management"}],"paths":{"/get_market_providers_product_metadata":{"get":{"summary":"Return Market providers' products metadata","x-cpanel-api-version":"WHM API 1","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"}],"tags":["Market","Product Management"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"properties":{"version":{"description":"The version of the API function.","example":"1","type":"integer"},"command":{"description":"The method name called.","example":"get_market_providers_product_metadata","type":"string"},"result":{"example":"1","enum":["0","1"],"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","type":"integer"},"reason":{"type":"string","example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds."}}},"data":{"type":"object","properties":{"product_metadata":{"type":"array","items":{"type":"object","properties":{"attributes":{"oneOf":[{"$ref":"#/components/schemas/MarketProviderMetaData"},{"$ref":"#/components/schemas/SSLMarketProviderMetaData"}]},"provider_name":{"type":"string","description":"The cPanel Market provider's name.","example":"cPStore"},"product_id":{"type":"string","example":"123","description":"The product's ID."},"provider_display_name":{"example":"cPanel Store","description":"The cPanel Market provider's display name.","type":"string"}}}}}}}}}},"description":"HTTP Request was successful."}},"x-cpanel-available-version":"56","parameters":[],"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"}}},"x-tagGroups":[{"name":"cPanel Market","tags":["Product Management"]}],"openapi":"3.0.2","info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","name":"WebPros International, LLC","email":"cs@cpanel.net"},"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/"},"externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"components":{"schemas":{"MarketProviderMetaData":{"properties":{"product_id":{"type":"object","properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"description":"Metadata information about the product's ID."},"price":{"properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"type":"object","description":"Metadata information about the product's price."},"icon_mime_type":{"type":"object","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the icon's mime type."},"product_description":{"type":"object","properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the product's description."},"recommended":{"type":"object","properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"description":"Metadata information about whether the product is recommended."},"price_unit":{"type":"object","properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the product's price per unit."},"display_name":{"type":"object","properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the product's display name."},"product_group":{"type":"object","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the product's group label."},"minimum_server_price":{"type":"object","properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the minimum server price for the certificate."},"enabled":{"type":"object","properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"description":"Metadata information about whether the product is enabled in the Market."},"icon":{"properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"type":"object","description":"Metadata information about the product's icon file."}},"type":"object"},"SSLMarketProviderMetaData":{"allOf":[{"$ref":"#/components/schemas/MarketProviderMetaData"},{"type":"object","properties":{"x_ssl_per_domain_pricing":{"properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"type":"object","description":"Metadata information about the product's pricing per domain."},"x_price_per_wildcard_domain":{"type":"object","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Information about the price per wildcard certificate."},"x_wildcard_parent_domain_free":{"type":"object","properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"description":"Information about whether the provider includes the price of the parent domain in the price of a wildcard certificate."},"x_price_per_wildcard_domain_maximum":{"type":"object","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Information about the maximum allowable price per wildcard certificate."},"x_identity_verification":{"type":"object","properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Defines a schema for identity verification information for OV and EV certificates."},"x_max_http_redirects":{"description":"Information about the maximum number of HTTP redirections that the provider allows during a Domain Control Validation (DCV) check of the domain or domains in the certificate.","type":"object","properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}}},"x_warn_after":{"description":"Information about a length of time after which the cPanel interface will warn the user that there may be a problem with the order.","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"type":"object"},"x_supports_dns_dcv":{"properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"type":"object","description":"Information about whether the product supports DNS-based DCV."},"x_price_per_domain_minimum":{"type":"object","properties":{"read_only":{"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute.","enum":["0","1"],"example":"1"}},"description":"Information about the minimum allowable price per domain for the certificate."},"x_price_per_wildcard_domain_minimum":{"description":"Information about the minimum allowable price per wildcard certificate.","type":"object","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}}},"x_price_per_domain":{"type":"object","properties":{"read_only":{"example":"1","enum":["0","1"],"description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"description":"Metadata information about the product's price per domain."},"x_price_per_domain_maximum":{"description":"Information about the maximum allowable price per domain for the certificate.","properties":{"read_only":{"enum":["0","1"],"example":"1","description":"Whether the attribute is read-only.\n* `1` — The attribute is read-only.\n* `0` — System administrators can edit the attribute."}},"type":"object"}}}]}},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}}},"api_token_update":{"components":{"schemas":{},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"security":[{"BasicAuth":[]}],"externalDocs":{"url":"https://cpanel.net/developers/"},"info":{"description":"WHM API.","version":"11.89.0.9999","license":{"url":"https://cpanel.net/legal-notices/","name":"cPanel License"},"termsOfService":"https://cpanel.net/legal-notices/","contact":{"email":"cs@cpanel.net","url":"https://cpanel.net/support/","name":"WebPros International, LLC"},"title":"WHM API"},"openapi":"3.0.2","x-tagGroups":[{"tags":["API Token Management"],"name":"API Development Tools"}],"paths":{"/api_token_update":{"get":{"description":"This function updates an API token's settings.","operationId":"api_token_update","parameters":[{"required":"true","name":"token_name","in":"query","schema":{"type":"string","example":"token"},"description":"The API token's name."},{"name":"new_name","in":"query","required":"false","description":"The API token's new name. If you do not use this parameter, the API token's name\nremains the same.\n\n**Note:**\n\n* An API token name's maximum length is 50 characters, and the name may **only**\ncontain alphanumeric characters, dashes (`-`), and underscores (`_`).\n\n* You **must** assign a name that does **not** already exist to the API token.","schema":{"type":"string","maxLength":"50","example":"example"}},{"required":"false","in":"query","name":"acl","schema":{"type":"string"},"examples":{"multiple":{"summary":"Assign multiple privilges.","value":"acl-0=create-acct acl-1=list-accts acl-2=kill-acct"},"single":{"summary":"Assign a single privilege.","value":"all"}},"description":"The new privileges to assign to the token. If you do **not** use this parameter,\nthe system will assign all of your privileges to the token.\n\nFor a list of Access Control List (ACL) privileges, read our\n[Edit Reseller Nameservers and Privileges](https://docs.cpanel.net/whm/resellers/edit-reseller-nameservers-and-privileges/#feature-limits-acl-lists)\ndocumentation.\n\n**Note:**\n\n* You can **only** assign privileges that you possess to the API token.\n\n* The function replaces **all** current privileges with the privileges that you pass\nin this parameter.\n\n* To assign multiple privileges to the token, increment the parameter name.\nFor example, `acl-1`, `acl-2`, `acl-3`."},{"in":"query","name":"expires_at","required":"false","description":"The API token's expiration time. If you do not use this parameter,\nthe API token will **not** expire.\n\n* A date, in [Unix Epoch format](http://en.wikipedia.org/wiki/Unix_time).\n* `0` — The API token will **not** expire.\n\n**Important:**\n\nWhen an API token expires, the system does **not** delete it. You **must**\nmanually delete expired API tokens.","schema":{"type":"integer","default":"0","format":"unix_timestamp","example":"1609372800"}},{"required":"false","in":"query","name":"whitelist_ip","schema":{"anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"},{"format":"cidr","type":"string"},{"type":"string","enum":["any"]}]},"examples":{"clear":{"value":"whitelist_ip=any","summary":"Clear a token's whitelisted IPs list."},"single":{"value":"whitelist_ip=192.0.2.8/29","summary":"Assign a single IP or CIDR range."},"multiple":{"value":"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","summary":"Assign multiple IPs or CIDR ranges."}},"description":"The new remote IP or CIDR IP ranges to assign to this token. If you do not use this parameter, the system\ndoes not limit which IPs can use this token.\n\n**Note:**\n\n* The function replaces **all** current whitelisted IPs with the IPs you pass\nin this parameter.\n\n* To assign multiple whitelisted IPs to the token, increment the parameter name. For\nexample: `whitelist_ip-0`, `whitelist_ip-1`, `whitelist_ip-2`.\n\n* If a token has whitelisted IPs set, they can be cleared by passing `whitelist_ip=any` as a parameter.\nThis will allow any IP to make API calls using that token."}],"x-cpanel-available-version":"68","responses":{"200":{"description":"HTTP Request was successful.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"expires_at":{"type":"integer","nullable":"true","example":"1609372800","description":"The API token's expiration time.\n\n**Note:**\n\nA `null` value means that the API token does **not** expire.","format":"unix_timestamp"},"create_time":{"type":"integer","example":"1483625276","format":"unix_timestamp","description":"The API token's creation time."},"whitelist_ips":{"type":"array","items":{"anyOf":[{"format":"ipv4","type":"string"},{"type":"string","format":"ipv6"},{"format":"cidr","type":"string"}]},"description":"List of remote IP or CIDR IP ranges this token may be used from.","example":["192.0.2.1","192.0.2.2","192.0.2.8/29","fc00:abcd:0000:0000:0000:0000:0000:000f","2620:0000:28a4:0000:0000:0000:0000:0000/48"],"nullable":"true"},"acls":{"type":"array","items":{"type":"string"},"description":"A list of privileges assigned to the token.","example":["create-acct","kill-acct","list-accts"]},"name":{"example":"example","description":"The API token's name.\n\n**Note:**\n\n* This function returns the API token's new name when you use\nthe `new_name` parameter.\n\n* Use this value to revoke an API token with WHM API 1's `api_token_revoke`\nfunction.","type":"string"}}},"metadata":{"properties":{"reason":{"type":"string","description":"The reason 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":{"example":"1","enum":["1","0"],"description":"* `1` — Success.\n* `0` – Failed. Check the `reason` field for more details.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"api_token_update"},"version":{"example":"1","description":"The version of the API function.","type":"integer"}}}}}}}}},"tags":["Authentication","API Token Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n  api_token_update \\\n  token_name='token'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/api_token_update?api.version=1&token_name=token"}],"x-cpanel-api-version":"WHM API 1","summary":"Update WHM API token's settings"}}},"tags":[{"name":"Authentication","description":"The Authentication module for WHM API 1."},{"name":"API Token Management","description":"API Development Tools / API Token Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"port":{"description":"The WHM port.","default":"2087"},"host":{"description":"The hostname of a server running WHM.","default":"whm-server.tld"}},"description":"A server running WHM."}]},"has_mycnf_for_cpuser":{"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{}},"openapi":"3.0.2","externalDocs":{"url":"https://cpanel.net/developers/"},"security":[{"BasicAuth":[]}],"info":{"title":"WHM API","contact":{"url":"https://cpanel.net/support/","email":"cs@cpanel.net","name":"WebPros International, LLC"},"description":"WHM API.","version":"88","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/"},"tags":[{"name":"Accounts","description":"The Accounts module for WHM API 1."},{"description":"Accounts / Account Management","name":"Account Management"}],"servers":[{"url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"description":"The WHM port.","default":"2087"}},"description":"A server running WHM."}],"x-tagGroups":[{"name":"Accounts","tags":["Account Management"]}],"paths":{"/has_mycnf_for_cpuser":{"get":{"x-cpanel-api-version":"WHM API 1","summary":"Validate MySQL Configuration file","tags":["Accounts","Account Management"],"x-codeSamples":[{"source":"whmapi1 --output=jsonpretty \\\n  has_mycnf_for_cpuser \\\n  user='user'\n","lang":"Shell","label":"CLI"},{"source":"https://hostname.example.com:2087/cpsess##########/json-api/has_mycnf_for_cpuser?api.version=1&user=user","lang":"HTTP","label":"URL"}],"x-cpanel-available-version":"11.40","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"result":{"type":"integer","description":"- `1` - Success\n- `0` - Failed: Check the reason field for more details.","enum":["0","1"],"example":"1"},"version":{"example":"1","description":"The version of the API function.","type":"integer"},"command":{"type":"string","description":"The method name called.","example":"has_mycnf_for_cpuser"},"reason":{"example":"OK","description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","type":"string"}}},"data":{"type":"object","properties":{"has_mycnf_for_cpuser":{"example":"1","enum":["0","1"],"description":"Whether a valid .my.cnf file exists in the account's home directory.\n- `1` -  Exists.\n- `0` -  Does not exist.","type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"operationId":"has_mycnf_for_cpuser","description":"This function checks whether a cPanel user's home directory contains\na valid .my.cnf file.","parameters":[{"in":"query","name":"user","required":"true","description":"The cPanel account username.","schema":{"type":"string","example":"user"}}]}}}}}