Child pages
  • WHM API 1 Functions - package_manager_get_build_log

Versions Compared

Key

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

Description

Excerpt

This function returns build log content.

 
Panel
bgColor#F2F2F2
borderStylenone

Examples




Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/package_manager_get_build_log?api.version=1&build=1234&offset=4567



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/package_manager_get_build_log?api.version=1&build=1234&offset=4567



Expand
titleCommand Line


Code Block
languagebash
whmapi1 package_manager_get_build_log build=1234 offset=4567

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
  {  
   "data":{  
      "offset":9672,
      "content":[  
         "line1",
         "line2",
         "line2"
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"package_manager_get_build_log"
   }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <data>
        <offset>9672</offset>
        <content>line1</content>
        <content>line2</content>
        <content>line3</content>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>package_manager_get_build_log</command>
    </metadata>
</result>


 

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

ParameterTypeDescriptionPossible valuesExample
buildinteger

Required

This parameter identifies the build process when the system performs WHM's package_manager_submit_actions API call.

An integer value.

1234
offsetinteger

Required

This parameter indicates the start position, in bytes, in the build log from which you wish to display entries.

An integer value.
4567

 

Returns

ReturnTypeDescriptionPossible valuesExample
offsetinteger

This return displays the last position, in bytes, that the system read to in the build log. You can use it for subsequent calls.

An integer value.9672
contentarrayThis returns displays the most recent build log entries.A valid array.line2
still_runningBoolean

Whether the build process is in progress.

  • 1 — The build is in progress.
  • 0 — The build is complete. 
1