system.crash

Description

Provides methods to access and modify software crash information.

Namespace:

system.crash

Method: createCrashNote

Description:

Create a crash note

Parameters:

  • string sessionKey

  • int crashId

  • string subject

  • string details

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteCrash

Description:

Delete a crash with given crash id.

Parameters:

  • string sessionKey

  • int crashId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteCrashNote

Description:

Delete a crash note

Parameters:

  • string sessionKey

  • int crashNoteId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getCrashCountInfo

Description:

Return date of last software crashes report for given system

Parameters:

  • string sessionKey

  • int serverId

Returns:

  • struct - Crash Count Information

    • int "total_count" - Total number of software crashes for a system

    • int "unique_count" - Number of unique software crashes for a system

    • dateTime.iso8601 "last_report" - Date of the last software crash report

Method: getCrashFile

Description:

Download a crash file.

Parameters:

  • string sessionKey

  • int crashFileId

Returns:

  • array :

    • byte - base64 encoded crash file

Method: getCrashFileUrl

Description:

Get a crash file download url.

Parameters:

  • string sessionKey

  • int crashFileId

Returns:

  • string url - The crash file download url

Method: getCrashNotesForCrash

Description:

List crash notes for crash

Parameters:

  • string sessionKey

  • int crashId

Returns:

  • array :

    • struct - crashNote

      • int "id"

      • string "subject"

      • string "details"

      • string "updated"

Method: getCrashOverview

Description:

Get Software Crash Overview

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct - crash

      • string "uuid" - Crash UUID

      • string "component" - Package component (set if unique and non empty)

      • int "crash_count" - Number of crashes occurred

      • int "system_count" - Number of systems affected

      • dateTime.iso8601 "last_report" - Last crash occurence

Method: getCrashesByUuid

Description:

List software crashes with given UUID

Parameters:

  • string sessionKey

  • string uuid

Returns:

  • array :

    • struct - crash

      • int "server_id" - ID of the server the crash occurred on

      • string "server_name" - Name of the server the crash occurred on

      • int "crash_id" - ID of the crash with given UUID

      • int "crash_count" - Number of times the crash with given UUID occurred

      • string "crash_component" - Crash component

      • dateTime.iso8601 "last_report" - Last crash occurence

Method: listSystemCrashFiles

Description:

Return list of crash files for given crash id.

Parameters:

  • string sessionKey

  • int crashId

Returns:

  • array :

    • struct - crashFile

      • int "id"

      • string "filename"

      • string "path"

      • int "filesize"

      • boolean "is_uploaded"

      • date "created"

      • date "modified"

Method: listSystemCrashes

Description:

Return list of software crashes for a system.

Parameters:

  • string sessionKey

  • int serverId

Returns:

  • array :

    • struct - crash

      • int "id"

      • string "crash"

      • string "path"

      • int "count"

      • string "uuid"

      • string "analyzer"

      • string "architecture"

      • string "cmdline"

      • string "component"

      • string "executable"

      • string "kernel"

      • string "reason"

      • string "username"

      • date "created"

      • date "modified"