--- updatedAt: 2026-07-10T17:11:53.000Z --- # List events using the PMUL V2 Event API Get a list of events for a host. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "description": "This API provides access to control BeyondTrust software for Endpoint Privilege Management Linux.", "title": "Endpoint Privilege Management Linux API", "version": "25.1.6" }, "security": [ { "nomine-authorizer": [] } ], "paths": { "/api/pbul/{hostid}/eventswithtotal": { "get": { "description": "Get a list of events for a host.", "tags": [ "PMUL", "saas" ], "summary": "List events using the PMUL V2 Event API", "operationId": "EventsWithTotalListParams", "parameters": [ { "x-go-name": "HostID", "description": "The Host ID to perform this operation on", "name": "hostid", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "x-go-name": "DestinationType", "description": "The type of destination to query for events", "name": "destinationType", "in": "query", "schema": { "type": "string", "enum": [ "db", "ff", "odbc" ] } }, { "x-go-name": "Destination", "description": "The database, flat file or ODBC DSN to query for events", "name": "destination", "in": "query", "schema": { "type": "string" } }, { "x-go-name": "Limit", "description": "The maximum number of results to return", "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "x-go-name": "Start", "description": "The recnum value of the event to start the page of data", "name": "start", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "x-go-name": "Offset", "description": "The offset value of the event to start the page of data", "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "x-go-name": "From", "description": "Beginning of epoch range to query", "name": "from", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "x-go-name": "To", "description": "End of epoch range to query", "name": "to", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "x-go-name": "Order", "description": "Sort order of records", "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "recnum", "epoch", "runcommand", "runuser", "runhost", "submituser", "submithost", "exitstatus", "etype" ] } }, { "x-go-name": "Direction", "description": "Sort direction", "name": "direction", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "x-go-name": "RunCommand", "description": "Filter by the command executed", "name": "runcommand", "in": "query", "schema": { "type": "string" } }, { "x-go-name": "RunUser", "description": "Filter by the user who executed a command", "name": "runuser", "in": "query", "schema": { "type": "string" } }, { "x-go-name": "SubmitUser", "description": "Filter by the user who submitted a command", "name": "submituser", "in": "query", "schema": { "type": "string" } }, { "x-go-name": "SubmitHost", "description": "Filter by the host used to submit a command", "name": "submithost", "in": "query", "schema": { "type": "string" } }, { "x-go-name": "RunHost", "description": "Filter by the host on which a command was executed", "name": "runhost", "in": "query", "schema": { "type": "string" } }, { "x-go-name": "EventType", "description": "Filter by the event type (Accept, Reject, Finish, Keystroke)", "name": "etype", "in": "query", "schema": { "type": "string", "enum": [ "A", "R", "F", "K" ] } } ], "responses": { "200": { "description": "ListEventResponseWithTotal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEventResponseWithTotal" } } } }, "400": { "$ref": "#/components/responses/TextError" } }, "x-amazon-apigateway-integration": { "type": "aws_proxy", "httpMethod": "POST", "uri": "${biulInvocationArn}" } } } }, "components": { "responses": { "TextError": { "description": "TextError An unknown error occured, details provided in body" } }, "schemas": { "Event": { "type": "object", "title": "Event represents an event logged by PMUL.", "properties": { "acacentrallogging": { "type": "integer", "format": "int64", "x-go-name": "AcaCentralLogging" }, "argc": { "type": "integer", "format": "int64", "x-go-name": "Argc" }, "argv": { "type": "array", "items": { "type": "string" }, "x-go-name": "Argv", "maxItems": 500 }, "bkgd": { "type": "integer", "format": "int64", "x-go-name": "Bkgd" }, "clienthost": { "type": "string", "x-go-name": "ClientHost" }, "clienthost_uuid": { "type": "string", "x-go-name": "ClientHostUUID" }, "clienthost_uuid_created": { "type": "integer", "format": "int64", "x-go-name": "ClientHostUUIDCreated" }, "command": { "type": "string", "x-go-name": "Command" }, "createtime": { "type": "string", "x-go-name": "CreateTime" }, "cwd": { "type": "string", "x-go-name": "Cwd" }, "date": { "type": "string", "x-go-name": "Date" }, "day": { "type": "integer", "format": "int64", "x-go-name": "Day" }, "dayname": { "type": "string", "x-go-name": "DayName" }, "env": { "type": "array", "items": { "type": "string" }, "x-go-name": "Env", "maxItems": 500 }, "event": { "type": "string", "x-go-name": "Event" }, "eventlog": { "type": "string", "x-go-name": "EventLog" }, "execute_via_su": { "type": "integer", "format": "int64", "x-go-name": "ExecuteViaSu" }, "exitdate": { "type": "string", "x-go-name": "ExitDate" }, "exitstatus": { "type": "string", "x-go-name": "ExitStatus" }, "exittime": { "type": "string", "x-go-name": "ExitTime" }, "false": { "type": "integer", "format": "int64", "x-go-name": "False" }, "group": { "type": "string", "x-go-name": "Group" }, "groups": { "type": "array", "items": { "type": "string" }, "x-go-name": "Groups", "maxItems": 500 }, "host": { "type": "string", "x-go-name": "Host" }, "hour": { "type": "integer", "format": "int64", "x-go-name": "Hour" }, "i18n_date": { "type": "string", "x-go-name": "I18nDate" }, "i18n_day": { "type": "string", "x-go-name": "I18nDay" }, "i18n_dayname": { "type": "string", "x-go-name": "I18nDayName" }, "i18n_exitdate": { "type": "string", "x-go-name": "I18nExitDate" }, "i18n_exittime": { "type": "string", "x-go-name": "I18nExitTime" }, "i18n_hour": { "type": "string", "x-go-name": "I18nHour" }, "i18n_minute": { "type": "string", "x-go-name": "I18nMinute" }, "i18n_month": { "type": "string", "x-go-name": "I18nMonth" }, "i18n_time": { "type": "string", "x-go-name": "I18nTime" }, "i18n_year": { "type": "string", "x-go-name": "I18nYear" }, "id": { "type": "string", "x-go-name": "ID" }, "iolog": { "type": "string", "x-go-name": "Iolog" }, "iolog_list": { "type": "array", "items": { "type": "string" }, "x-go-name": "IologList", "maxItems": 500 }, "iolog_part": { "type": "integer", "format": "int64", "x-go-name": "IologPart" }, "lineinfile": { "type": "string", "x-go-name": "LineInFile" }, "linenum": { "type": "string", "x-go-name": "LineNum" }, "localmode": { "type": "integer", "format": "int64", "x-go-name": "LocalMode" }, "logaccept_utc": { "type": "string", "x-go-name": "LogAcceptUTC" }, "logdversion": { "type": "string", "x-go-name": "LogdVersion" }, "logfinish_utc": { "type": "string", "x-go-name": "LogFinishUTC" }, "loghostip": { "type": "string", "x-go-name": "LogHostIP" }, "lognopassword": { "type": "integer", "format": "int64", "x-go-name": "LogNoPassword" }, "logpid": { "type": "integer", "format": "int64", "x-go-name": "LogPID" }, "logport": { "type": "string", "x-go-name": "LogPort" }, "logreject_utc": { "type": "string", "x-go-name": "LogRejectUTC" }, "logserver_utcoffset": { "type": "string", "x-go-name": "LogServerUTCOffset" }, "logserverlocale": { "type": "string", "x-go-name": "LogServerLocale" }, "logservers": { "type": "array", "items": { "type": "string" }, "x-go-name": "LogServers", "maxItems": 500 }, "logstderr": { "type": "integer", "format": "int64", "x-go-name": "LogStdErr" }, "logstdin": { "type": "integer", "format": "int64", "x-go-name": "LogStdIn" }, "logstdout": { "type": "integer", "format": "int64", "x-go-name": "LogStdOut" }, "master_utcoffset": { "type": "string", "x-go-name": "MasterUTCOffset" }, "masterdversion": { "type": "string", "x-go-name": "MasterdVersion" }, "masterhost": { "type": "string", "x-go-name": "MasterHost" }, "masterhostip": { "type": "string", "x-go-name": "MasterHostIP" }, "masterlocale": { "type": "string", "x-go-name": "MasterLocale" }, "minute": { "type": "integer", "format": "int64", "x-go-name": "Minute" }, "month": { "type": "integer", "format": "int64", "x-go-name": "Month" }, "nice": { "type": "integer", "format": "int64", "x-go-name": "Nice" }, "noexec": { "type": "integer", "format": "int64", "x-go-name": "Noexec" }, "offset": { "type": "integer", "format": "int64", "x-go-name": "Offset" }, "optarg": { "type": "string", "x-go-name": "OptArg" }, "opterr": { "type": "integer", "format": "int64", "x-go-name": "OptErr" }, "optimizedrunmode": { "type": "integer", "format": "int64", "x-go-name": "OptimizedRunMode" }, "optind": { "type": "integer", "format": "int64", "x-go-name": "OptInd" }, "optopt": { "type": "string", "x-go-name": "OptOpt" }, "optreset": { "type": "integer", "format": "int64", "x-go-name": "OptReset" }, "optstrictparameters": { "type": "integer", "format": "int64", "x-go-name": "OptStrictParameters" }, "passwordloggingprompts": { "type": "array", "items": { "type": "string" }, "x-go-name": "PasswordLoggingPrompts", "maxItems": 500 }, "pbclientcertificateissuer": { "type": "string", "x-go-name": "PbClientCertificateIssuer" }, "pbclientcertificatesubject": { "type": "string", "x-go-name": "PbClientCertificateSubject" }, "pbclientmode": { "type": "string", "x-go-name": "PbClientMode" }, "pbclientname": { "type": "string", "x-go-name": "PbClientName" }, "pblogdcertificateissuer": { "type": "string", "x-go-name": "PbLogdCertificateIssuer" }, "pblogdcertificatesubject": { "type": "string", "x-go-name": "PbLogdCertificateSubject" }, "pblogdmachine": { "type": "string", "x-go-name": "PbLogdMachine" }, "pblogdnodename": { "type": "string", "x-go-name": "PbLogdNodeName" }, "pblogdrelease": { "type": "string", "x-go-name": "PbLogdRelease" }, "pblogdsysname": { "type": "string", "x-go-name": "PbLogdSysName" }, "pblogdversion": { "type": "string", "x-go-name": "PbLogdVersion" }, "pbmasterdcertificateissuer": { "type": "string", "x-go-name": "PbMasterdCertificateIssuer" }, "pbmasterdcertificatesubject": { "type": "string", "x-go-name": "PbMasterdCertificateSubject" }, "pbmasterdmachine": { "type": "string", "x-go-name": "PbMasterdMachine" }, "pbmasterdnodename": { "type": "string", "x-go-name": "PbMasterdNodeName" }, "pbmasterdrelease": { "type": "string", "x-go-name": "PbMasterdRelease" }, "pbmasterdsysname": { "type": "string", "x-go-name": "PbMasterdSysName" }, "pbmasterdversion": { "type": "string", "x-go-name": "PbMasterdVersion" }, "pbrisklevel": { "type": "integer", "format": "int64", "x-go-name": "PbRiskLevel" }, "pbrunmachine": { "type": "string", "x-go-name": "PbRunMachine" }, "pbrunnodename": { "type": "string", "x-go-name": "PbRunNodeName" }, "pbrunrelease": { "type": "string", "x-go-name": "PbRunRelease" }, "pbrunsysname": { "type": "string", "x-go-name": "PbRunSysName" }, "pbrunversion": { "type": "string", "x-go-name": "PbRunVersion" }, "pbul_api_version": { "type": "string", "x-go-name": "PBULAPIVersion" }, "pbulacanoexitonerror": { "type": "integer", "format": "int64", "x-go-name": "PbulAcaNoExitOnError" }, "pbulacapolicy": { "type": "array", "items": { "type": "string" }, "x-go-name": "PbulAcaPolicy", "maxItems": 500 }, "pbulacasessionhistory": { "type": "integer", "format": "int64", "x-go-name": "PbulAcaSessionHistory" }, "pbversion": { "type": "string", "x-go-name": "PbVersion" }, "pid": { "type": "integer", "format": "int64", "x-go-name": "PID" }, "ptyflags": { "type": "integer", "format": "int64", "x-go-name": "PtyFlags" }, "recnum": { "type": "integer", "format": "int64", "x-go-name": "Recnum" }, "rejectnullpasswords": { "type": "integer", "format": "int64", "x-go-name": "RejectNullPasswords" }, "requestuser": { "type": "string", "x-go-name": "RequestUser" }, "rlimit_as": { "type": "integer", "format": "int64", "x-go-name": "RlimitAs" }, "rlimit_core": { "type": "integer", "format": "int64", "x-go-name": "RlimitCore" }, "rlimit_cpu": { "type": "integer", "format": "int64", "x-go-name": "RlimitCPU" }, "rlimit_data": { "type": "integer", "format": "int64", "x-go-name": "RlimitData" }, "rlimit_fsize": { "type": "integer", "format": "int64", "x-go-name": "RlimitFsize" }, "rlimit_locks": { "type": "integer", "format": "int64", "x-go-name": "RlimitLocks" }, "rlimit_memlock": { "type": "integer", "format": "int64", "x-go-name": "RlimitMemlock" }, "rlimit_nofile": { "type": "integer", "format": "int64", "x-go-name": "RlimitNofile" }, "rlimit_nproc": { "type": "integer", "format": "int64", "x-go-name": "RlimitNproc" }, "rlimit_rss": { "type": "integer", "format": "int64", "x-go-name": "RlimitRss" }, "rlimit_stack": { "type": "integer", "format": "int64", "x-go-name": "RlimitStack" }, "runargv": { "type": "array", "items": { "type": "string" }, "x-go-name": "RunArgv", "maxItems": 500 }, "runbkgd": { "type": "integer", "format": "int64", "x-go-name": "RunBkgd" }, "runcommand": { "type": "string", "x-go-name": "RunCommand" }, "runcwd": { "type": "string", "x-go-name": "RunCwd" }, "runenablerlimits": { "type": "integer", "format": "int64", "x-go-name": "RunEnableRlimits" }, "runenv": { "type": "array", "items": { "type": "string" }, "x-go-name": "RunEnv", "maxItems": 500 }, "runfinish_utc": { "type": "string", "x-go-name": "RunFinishUTC" }, "rungroup": { "type": "string", "x-go-name": "RunGroup" }, "rungroups": { "type": "array", "items": { "type": "string" }, "x-go-name": "RunGroups", "maxItems": 500 }, "runhost": { "type": "string", "x-go-name": "RunHost" }, "runlocalmode": { "type": "integer", "format": "int64", "x-go-name": "RunLocalMode" }, "runnice": { "type": "integer", "format": "int64", "x-go-name": "RunNice" }, "runoptimizedrunmode": { "type": "integer", "format": "int64", "x-go-name": "RunOptimizedRunMode" }, "runpid": { "type": "integer", "format": "int64", "x-go-name": "RunPID" }, "runptyflags": { "type": "integer", "format": "int64", "x-go-name": "RunPtyFlags" }, "runrlimit_as": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitAs" }, "runrlimit_core": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitCore" }, "runrlimit_cpu": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitCPU" }, "runrlimit_data": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitData" }, "runrlimit_fsize": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitFsize" }, "runrlimit_locks": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitLocks" }, "runrlimit_memlock": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitMemlock" }, "runrlimit_nofile": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitNofile" }, "runrlimit_nproc": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitNproc" }, "runrlimit_rss": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitRss" }, "runrlimit_stack": { "type": "integer", "format": "int64", "x-go-name": "RunRlimitStack" }, "runsolarisproject": { "type": "string", "x-go-name": "RunSolarisProject" }, "runstart_utc": { "type": "string", "x-go-name": "RunStartUTC" }, "runtimeout": { "type": "integer", "format": "int64", "x-go-name": "RunTimeout" }, "runtimeoutoverride": { "type": "integer", "format": "int64", "x-go-name": "RunTimeoutOverride" }, "runumask": { "type": "integer", "format": "int64", "x-go-name": "RunUmask" }, "runuser": { "type": "string", "x-go-name": "RunUser" }, "solarisproject": { "type": "string", "x-go-name": "SolarisProject" }, "specifiedhost": { "type": "integer", "format": "int64", "x-go-name": "SpecifiedHost" }, "specifieduser": { "type": "integer", "format": "int64", "x-go-name": "SpecifiedUser" }, "status": { "type": "integer", "format": "int64", "x-go-name": "Status" }, "submit_utc": { "type": "string", "x-go-name": "SubmitUTC" }, "submithost": { "type": "string", "x-go-name": "SubmitHost" }, "submithostip": { "type": "string", "x-go-name": "SubmitHostIP" }, "submitlocale": { "type": "string", "x-go-name": "SubmitLocale" }, "submitpid": { "type": "integer", "format": "int64", "x-go-name": "SubmitPID" }, "subprocuser": { "type": "string", "x-go-name": "SubprocUser" }, "taskpid": { "type": "integer", "format": "int64", "x-go-name": "TaskPID" }, "taskttyname": { "type": "string", "x-go-name": "TaskTtyName" }, "testmaster": { "type": "integer", "format": "int64", "x-go-name": "TestMaster" }, "time": { "type": "string", "x-go-name": "Time" }, "timezone": { "type": "string", "x-go-name": "Timezone" }, "true": { "type": "integer", "format": "int64", "x-go-name": "True" }, "ttyname": { "type": "string", "x-go-name": "TtyName" }, "umask": { "type": "integer", "format": "int64", "x-go-name": "Umask" }, "uniqueid": { "type": "string", "x-go-name": "UniqueID" }, "unixtimestamp": { "type": "integer", "format": "int64", "x-go-name": "UnixTimestamp" }, "user": { "type": "string", "x-go-name": "User" }, "user_fields": { "type": "object", "additionalProperties": {}, "x-go-name": "UserFields" }, "xwinforward": { "type": "integer", "format": "int64", "x-go-name": "XwinForward" }, "year": { "type": "integer", "format": "int64", "x-go-name": "Year" } }, "x-go-package": "pbsmc/data/dtos" }, "ListEventResponseWithTotal": { "type": "object", "title": "ListEventResponseWithTotal represents the response from the ListEvent API call.", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" }, "x-go-name": "Events", "maxItems": 500 }, "totalevents": { "type": "integer", "format": "int64", "x-go-name": "TotalEvents" } }, "x-go-package": "pbsmc/data/dtos" } }, "securitySchemes": { "nomine-authorizer": { "type": "apiKey", "name": "Authorization", "in": "header", "x-amazon-apigateway-authtype": "custom", "x-amazon-apigateway-authorizer": { "type": "request", "authorizerUri": "${authorizerInvokeArn}", "authorizerResultTtlInSeconds": 300, "identitySource": "method.request.header.Authorization" } } } }, "servers": [ { "url": "https://{example.com}" } ], "x-readme": {} } ```