Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function calls the WHM API 1  send_test_posturl function for your specified POST notification URLs.

You can specify POST notification URLs in the Contact Information section of WHM's Basic WebHost Manager Setup interface ( WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup) .

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/verify_posturl_access?api.version=1



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/verify_posturl_access?api.version=1



Expand
titleCommand Line


Code Block
languagebash
whmapi1 verify_posturl_access

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "verify_posturl_access"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>verify_posturl_access</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

This function does not accept parameters.

Returns

This function returns the results of the WHM API 1  send_test_posturl function.

Note
titleNote:

If the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup) contains multiple POST URLs, the function will return an array that contains the results for each URL.