You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Developer Documentation
Child pages
  • WHM API 1 Functions - package_manager_get_build_log
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI


 cPanel Analytics

participate_in_analytics

 Server Administration

add_configclusterserver

configurebackgroundprocesskiller

configureservice

cors_proxy_get

create_user_session

delete_configclusterserver

enable_monitor_all_enabled_services

get_all_contact_importances

get_api_calls

get_api_pages

get_appconfig_application_list

get_application_contact_event_importance  

get_application_contact_importance

get_available_profiles

get_current_profile

get_linked_server_node

get_password_strength

get_remote_access_hash

get_server_node_status

get_service_config

get_service_config_key

get_tcp4_sockets

get_tcp6_sockets

get_tweaksetting

get_udp4_sockets

get_udp6_sockets

get_update_availability

get_users_links

getdiskusage

gethostname

is_role_enabled

link_server_node_with_api_token

list_configclusterservers

list_linked_server_nodes

list_user_worker_nodes

loadavg

nvget

nvset

personalization_get

personalization_set

purchase_a_license

reboot

remove_in_progress_exim_config_edit

restartservice

restore_config_from_file

restore_config_from_upload

run_cpkeyclt

send_test_posturl

send_test_pushbullet_note

servicestatus

set_application_contact_event_importance

set_application_contact_importance  

set_primary_servername

set_service_config_key

set_service_proxy_backends

set_tweaksetting

sethostname

setminimumpasswordstrengths

start_profile_activation

system_needs_reboot

systemloadavg

unlink_server_node

uapi_cpanel

unset_all_service_proxy_backends

update_configclusterserver

update_contact_email

update_linked_server_node

verify_aim_access

verify_icq_access

verify_oscar_access

verify_posturl_access

verify_pushbullet_access

verify_slack_access


Description

This function returns build log content.

 

Examples

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/package_manager_get_build_log?api.version=1&build=1234&offset=4567
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/package_manager_get_build_log?api.version=1&build=1234&offset=4567
 Command Line
whmapi1 package_manager_get_build_log build=1234 offset=4567


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
  {  
   "data":{  
      "offset":9672,
      "content":[  
         "line1",
         "line2",
         "line2"
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"package_manager_get_build_log"
   }
}
 Output (XML)
<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>



Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
buildinteger

Required

The build process ID.

An integer value that WHM's package_manager_submit_actions  function returns.

1234
offsetinteger

Required

The position in the build log from which you wish to display entries.

An integer value, in bytes.
4567


Returns

ReturnTypeDescriptionPossible valuesExample
offsetinteger

The last position that the system read in the build log.

An integer value, in bytes.9672
contentarrayThe most recent build log entries.A valid array.line2
still_runningBoolean

Whether the build process is in progress.

  • 1 — In progress.
  • 0 — Complete. 
1

Function information

API Version:

WHM API 1

Available in:

WHM 11.52

Methods:

GET, POST

Required Parameters:

build, offset

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions