Audit API

Use the Audit API to retrive audit log data from your Control Room.
Prerequisites

Users with the AAE_Admin role or users with the View everyone audit log actions permission can view audit logs for the Control Room.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header file example: -H X-Authorization <authentication token> or Authorization:Bearer <bearer token>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.3.1.1

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

Audit

post /messages/list

Audit

Up

post /messages/list

Fetch Audit data for a given input (messagesListPost)

<p>Request audit data for a given input combination of date filter, sorting mechanism, and pagination.</p> <p><strong>Note:</strong> The Fetch Audit data API retrieves a maximum of 400 rows per response. Increment the offset value to fetch the next set of results.</p>

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter — Filter, Sort and Pagination combination for Audit data output

Return type

Object

Example data

Content-Type: application/json

{
  "AuditResults" : {
    "page" : {
      "totalFilter" : 1,
      "total" : 48852894,
      "offset" : 0
    },
    "list" : [ {
      "hostName" : "docs-kernel-622f7d9b78-wtjl9",
      "createdBy" : "28",
      "environmentName" : "xxxx",
      "requestId" : "131f189732c8ba52",
      "eventDescription" : "eventDescription",
      "objectName" : "xxxyy",
      "id" : "ZXcjOIQBL9lTQvkn-h3v",
      "source" : "Control Room",
      "activityType" : "LOGIN",
      "userName" : "cr_user",
      "createdOn" : "2022-11-01T09:52:16Z",
      "status" : "Successful"
    }, {
      "hostName" : "docs-kernel-622f7d9b78-wtjl9",
      "createdBy" : "28",
      "environmentName" : "xxxx",
      "requestId" : "131f189732c8ba52",
      "eventDescription" : "eventDescription",
      "objectName" : "xxxyy",
      "id" : "ZXcjOIQBL9lTQvkn-h3v",
      "source" : "Control Room",
      "activityType" : "LOGIN",
      "userName" : "cr_user",
      "createdOn" : "2022-11-01T09:52:16Z",
      "status" : "Successful"
    } ]
  }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK Object

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

409

Conflict Error

500

Internal Server error Error

Models

Methods

Table of Contents

AuditMessage
AuditResults
Error
Filter
FilterRequest
Iso8601DateFormat
Ops
PageRequest
Sort

`AuditMessage` Up

id (optional)

String Id of the Audit activity

example: ZXcjOIQBL9lTQvkn-h3v

eventDescription

String Description of the Event

activityType

String The type of activity performed

Enum:

ACTIVATE_AUTOMATION

ADD_CREDENTIAL

ADD_LOCKER

ADD_MANUAL_DEPENDENCY

ADD_ROLE

ALLOCATE_LICENSE

AUDIT_ERROR

AUDIT_UNSET_ACTIVITY_TYPE

AUTOMATION_MISFIRED

BI_ADD_USER_DASHBOARD

BI_COPY_DASHBOARD

BI_DELETE_DASHBOARD

BI_DELETE_USER_DASHBOARD

BI_END_TASK

BI_GET_TASK_DATA

BI_GET_USER_DASHBOARDS

BI_OPERATIONS

BI_REGISTER_DASHBOARD

BI_RUN_DATA

BI_SAVE_DASHBOARD

BI_SEARCH_DASHBOARD

BI_START_TASK

BI_UPDATE_DASHBOARD

BOT_RUNNER_SESSION

CHECKOUT

CLIENT_LOGIN

CONFIGURE_CREDENTIAL_VAULT

CONNECT_CREDENTIAL_VAULT

CR_CONFIGURATIONS

CREATE_AUTOMATION

CREATE_FOLDER

CREATE_USER

CV_SETTING

DEACTIVATE_AUTOMATION

DELETE_AUTOMATION

DELETE_BOT

DELETE_CREDENTIAL

DELETE_FILE

DELETE_FOLDER

DELETE_LOCKER

DELETE_ROLE

DELETE_USER

DEPLOYMENT_AUTOMATION

DISABLE_USER

DOWNLOAD_BOT

DOWNLOAD_FILE

DOMAIN_CREDENTIAL_RESET

EDIT_BOT

EDIT_SETTINGS

EMAIL_NOTIFICATION

EMAIL_SETTING

ENABLE_USER

EXECUTE_AUTOMATION

EXPORT_BOT_FILES_API

FIRST_ADMIN_SETTINGS

FORCE_UNLOCK_BOT

FORCE_UNLOCK_FILE

IMPORT_BOT_FILES_API

INSTALL_LICENSE

LOGIN

LOGOUT

MIGRATION_FINISH

MIGRATION_START

AUDIT_MIGRATION_FINISH

AUDIT_MIGRATION_START

MOVE_TO_HISTORY

MULTI_LOGIN

POOL_CREATE_FAILED

POOL_CREATED_SUCCESSFULLY

POOL_DELETE_FAILED

POOL_DELETED_SUCCESSFULLY

POOL_UPDATE_FAILED

POOL_UPDATED_SUCCESSFULLY

QUEUE_CREATE_FAILED

QUEUE_CREATED

QUEUE_CREATED_DRAFT

QUEUE_DELETE_FAILED

QUEUE_DELETED

QUEUE_EXPORT

QUEUE_IMPORT

QUEUE_UPDATE_FAILED

QUEUE_UPDATED

READ_CREDENTIAL

READ_LOCKER

RELEASE_LICENSE

REMOVE_MANUAL_DEPENDENCY

RENAME_FOLDER

ROLLBACK

RUN_AUTOMATION

RUN_BOT_DISCONNECTED

RUN_BOT_ENDED

RUN_BOT_PAUSED

RUN_BOT_RECONNECTED

RUN_BOT_RESUMED

RUN_BOT_STOPPED

RUN_BOT_LOCAL_HOTKEY_FINISHED

RUN_BOT_LOCAL_HOTKEY_PAUSED

RUN_BOT_LOCAL_HOTKEY_RESUMED

RUN_BOT_LOCAL_HOTKEY_STARTED

RUN_BOT_LOCAL_HOTKEY_STOPPED

RUN_BOT_LOCAL_HOTKEY_SUSPENDED

RUN_BOT_LOCAL_SCHEDULE_FINISHED

RUN_BOT_LOCAL_SCHEDULE_PAUSED

RUN_BOT_LOCAL_SCHEDULE_RESUMED

RUN_BOT_LOCAL_SCHEDULE_STARTED

RUN_BOT_LOCAL_SCHEDULE_STOPPED

RUN_BOT_LOCAL_SCHEDULE_SUSPENDED

RUN_BOT_LOCAL_TRIGGER_FINISHED

RUN_BOT_LOCAL_TRIGGER_PAUSED

RUN_BOT_LOCAL_TRIGGER_RESUMED

RUN_BOT_LOCAL_TRIGGER_STARTED

RUN_BOT_LOCAL_TRIGGER_STOPPED

RUN_BOT_LOCAL_TRIGGER_SUSPENDED

RUN_LOGIC_LOCAL_CLIENT_FINISHED

RUN_LOGIC_LOCAL_CLIENT_PAUSED

RUN_LOGIC_LOCAL_CLIENT_RESUMED

RUN_LOGIC_LOCAL_CLIENT_STARTED

RUN_LOGIC_LOCAL_CLIENT_STOPPED

RUN_LOGIC_LOCAL_CLIENT_SUSPENDED

RUN_WORKFLOW_LOCAL_CLIENT_FINISHED

RUN_WORKFLOW_LOCAL_CLIENT_STARTED

RUN_WORKFLOW_LOCAL_CLIENT_STOPPED

RUN_WORKFLOW_LOCAL_SCHEDULE_FINISHED

RUN_WORKFLOW_LOCAL_SCHEDULE_STARTED

RUN_WORKFLOW_LOCAL_SCHEDULE_STOPPED

RUN_WORKFLOW_LOCAL_TRIGGER_FINISHED

RUN_WORKFLOW_LOCAL_TRIGGER_STARTED

RUN_WORKFLOW_LOCAL_TRIGGER_STOPPED

SCHEDULE_BOT_DISCONNECTED

SCHEDULE_BOT_ENDED

SCHEDULE_BOT_PAUSED

SCHEDULE_BOT_RECONNECTED

SCHEDULE_BOT_RESUMED

SCHEDULE_BOT_STOPPED

SEND_EMAIL

UNDO_CHECKOUT

UNLOCK_CREDENTIAL_VAULT

UPDATE_AUTOMATION

UPDATE_CREDENTIAL

UPDATE_CREDENTIAL_OWNERSHIP

UPDATE_LOCKER

UPDATE_ROLE

UPDATE_USER

UPLOAD_BOT

UPLOAD_FILE

VCS_SETTING

WLM_FILE_UPLOADED

WLM_LOAD_WORKITEMS

WORKITEM_CREATED

WORKITEM_CREATED_FAILED

WORKITEM_DELETED

WORKITEM_DELETED_FAILED

WORKITEM_UPDATED

WORKITEM_UPDATED_FAILED

example: LOGIN

environmentName (optional)

String Name of the environment

example: xxxx

hostName (optional)

String Name of the host

example: docs-kernel-622f7d9b78-wtjl9

userName

String UserName of the user who performed the activity

example: cr_user

status

String Status of the activity

Enum:

Unknown

Successful

Unsuccessful

example: Successful

source (optional)

String Source of the activity

example: Control Room

objectName (optional)

String Object Name

example: xxxyy

createdOn (optional)

Iso8601DateFormat

requestId (optional)

String ID of the request

example: 131f189732c8ba52

createdBy (optional)

String ID of the user

example: 28

`AuditResults` Up

page (optional)

Object Pagingation response

list (optional)

array[AuditMessage] List showing a collection of Audit activities

`Error` Up

code (optional)

Integer Error code

message (optional)

String Message describing error

details (optional)

String Details of an error

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

and

lt

le

eq

ne

ge

gt

substring

NONE

or

not

operands (optional)

array[Ops]

example: [{operator=gt, field=createdOn, value=2022-11-02T00:00:00.001Z}, {operator=substring, field=activityType, value=LOGIN}]

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

sort (optional)

array[Sort] Sort directions

filter (optional)

Filter

page (optional)

PageRequest

`Iso8601DateFormat` Up

`Ops` Up

Operands rules

operator (optional)

String Operator

Enum:

gt

lt

le

eq

ne

ge

and

substring

NONE

or

not

`PageRequest` Up

Pagingation rules

offset (optional)

Integer Page starting index

example: 0

length (optional)

Integer Page length

example: 1000

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

example: createdOn

direction (optional)

String Sorting direction

Enum:

asc

desc

example: desc

Automation 360

Audit-API